Paths
/v1/consumer-services/catalogs/country
To fetch the country details
This API will be used to fetch the country details
Content-Types that are acceptable for the response
List of acceptable human languages for response
The Authorization Token received during login
Client ID generated during application registration
128 bit UUID that you generate for every request
Country code in 2 character ISO 3166 format
channel where request originated
Business code identified during application registration
The request has succeeded.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/consumer-services/catalogs/metals
/v1/consumer-services/catalogs/metals/summary
/v1/consumer-services/catalogs/dollar/summary
dollar summary
This API is used to retreive dollar summary information
Client ID generated during application registration
The most recent Authorization token
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier
List of acceptable human languages for response
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel Id identifies the consumer from where the request comes
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | UserNotFound | CustomerId is Invalid |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/consumer-services/catalogs/dollar/{year}
To get dollar information
This API is used to retreive dollar information for last 8 years starting mentioned year
Client ID generated during application registration
The most recent Authorization token
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier
List of acceptable human languages for response
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel Id identifies the consumer from where the request comes
Year to pass to get forex rate for year-8 to year
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | UserNotFound | CustomerId is Invalid |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/consumer-services/catalogs/currencies
currencies
This API is used to retreive all currencies information
Client ID generated during application registration
The most recent Authorization token
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier
List of acceptable human languages for response
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel Id identifies the consumer from where the request comes
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | UserNotFound | CustomerId is Invalid |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/consumer-services/catalogs/currencies/continent
continent currencies
This API is used to retreive all currencies by continent information
Client ID generated during application registration
The most recent Authorization token
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier
List of acceptable human languages for response
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel Id identifies the consumer from where the request comes
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | UserNotFound | CustomerId is Invalid |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/consumer-services/catalogs/currencies/summary
currencies summary
This API is used to retreive currency summary information
Client ID generated during application registration
The most recent Authorization token
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier
List of acceptable human languages for response
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel Id identifies the consumer from where the request comes
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | UserNotFound | CustomerId is Invalid |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"country": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
}
}
}
{
"type": "object",
"properties": {
"countryName": {
"description": "Country code of address",
"type": "string",
"example": "AFGANISTAN"
}
}
}
This response is to get currency continent information
{
"type": "object",
"properties": {
"continent": {
"type": "array",
"items": {
"$ref": "#/definitions/Continent"
}
}
}
}
This response is to get Dollar summary information
{
"type": "object",
"properties": {
"dollarSummary": {
"type": "array",
"items": {
"$ref": "#/definitions/Currency"
}
}
}
}
This response is to get currency summary information
{
"type": "object",
"properties": {
"currency": {
"type": "array",
"items": {
"$ref": "#/definitions/Currency"
}
}
}
}
This response is to get currency information
{
"type": "object",
"properties": {
"currency": {
"type": "array",
"items": {
"$ref": "#/definitions/CurrencyDetail"
}
}
}
}
currency continent information
{
"type": "object",
"properties": {
"continent": {
"type": "string",
"description": "continent",
"example": "NORTH AMERICA"
},
"currency": {
"type": "array",
"items": {
"$ref": "#/definitions/Currency"
}
}
}
}
currency information
{
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"description": "currency code",
"example": "CAD"
},
"countryNameSpanish": {
"type": "string",
"description": "country name in Spanish",
"example": "Canada"
},
"countryName": {
"type": "string",
"description": "country name in English",
"example": "Canada"
},
"currencyDescriptionSpanish": {
"type": "string",
"description": "currency description in Spanish",
"example": "Dolar"
},
"currencyDescription": {
"type": "string",
"description": "currency description in English",
"example": "Dollar"
},
"salePrice": {
"type": "number",
"format": "double",
"description": "sale price",
"example": "1.30"
}
}
}
currency information
{
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"description": "currency code",
"example": "CAD"
},
"countryFlagImage": {
"type": "string",
"description": "country flag image GIF",
"example": "Canada.GIF"
},
"countryNameSpanish": {
"type": "string",
"description": "country name in Spanish",
"example": "Canada"
},
"countryName": {
"type": "string",
"description": "country name in English",
"example": "Canada"
},
"currencyDescriptionSpanish": {
"type": "string",
"description": "currency description in Spanish",
"example": "Dolar"
},
"currencyDescription": {
"type": "string",
"description": "currency description in English",
"example": "Dollar"
},
"buyPrice": {
"type": "number",
"format": "double",
"description": "buy price",
"example": "1.25"
},
"salePrice": {
"type": "number",
"format": "double",
"description": "sale price",
"example": "1.30"
}
}
}
This response is to get the dollar information
{
"type": "object",
"properties": {
"foreignExchange": {
"type": "array",
"items": {
"$ref": "#/definitions/ForeignExchange"
}
}
}
}
foreing exchange
{
"type": "object",
"properties": {
"foreignExchangeRate": {
"type": "number",
"format": "double",
"description": "foreign ExchangeRate",
"example": "1.25"
},
"month": {
"type": "integer",
"format": "int32",
"description": "month number",
"example": "01"
},
"year": {
"type": "integer",
"format": "int32",
"description": "year",
"example": "2010"
}
}
}
This response is to get the metals summary
{
"type": "object",
"properties": {
"coin": {
"type": "array",
"items": {
"$ref": "#/definitions/Coin"
}
}
}
}
This response is to get the metals information
{
"type": "object",
"properties": {
"metal": {
"type": "array",
"items": {
"$ref": "#/definitions/Metal"
}
}
}
}
metal information
{
"type": "object",
"properties": {
"metalType": {
"type": "string",
"description": "coin metal Type",
"example": "Oro"
},
"coinMetal": {
"type": "array",
"items": {
"$ref": "#/definitions/CoinMetal"
}
}
}
}
coin information
{
"type": "object",
"properties": {
"coinCategory": {
"type": "string",
"description": "metal coin category",
"example": "onzasoro"
},
"coin": {
"type": "array",
"items": {
"$ref": "#/definitions/Coin"
}
}
}
}
different coin detail information
{
"type": "object",
"properties": {
"buyPrice": {
"type": "number",
"format": "double",
"description": "buy price",
"example": "1.35"
},
"coinDenomination": {
"type": "string",
"description": "coin",
"example": "OroLibertad"
},
"metalCode": {
"type": "string",
"description": "metal Code",
"example": "OLIB"
},
"metalValue": {
"type": "string",
"description": "metal cost Value in mexican pesos",
"example": "1800"
},
"salePrice": {
"type": "number",
"format": "double",
"description": "sale price",
"example": "1.40"
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}