Paths
/v1/consumer-services/foreign-exchange/rate/{currencyCode}
Retrieve Foreign Exchange Rate
This API is used to get the Foreign Exchange Rate. The scope of the API is public, pre-login and entry-point
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
currency which has to be exchanged. It includes a value of ALL for the details about all the currencies
Successful operation.
| Type | Code | Details |
| error | invalidCard | Card not found or invalid |
| invalid | 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 |
/v1/consumer-services/foreign-exchange/updateinfo
retrieve number of records and date of modification
This API is used to retrieve the number of records and the date of modification. The scope of the API is public, pre-login and entry-point
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
Successful operation.
| Type | Code | Details |
| error | invalidCard | Card not found or invalid |
| invalid | 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 |
Definitions
Response for retrieving foreign currency exchange
{
"type": "array",
"items": {
"$ref": "#/definitions/ForeignExchange"
}
}
Response object for retrieveRateUpdateInfo API
{
"type": "object",
"properties": {
"recordCount": {
"description": "number of exchange rate records",
"type": "integer",
"example": 20
},
"lastUpdatedDate": {
"description": "date when the data was updated",
"type": "string",
"format": "date-time",
"example": "2017-01-19T16:39:57-06:00"
}
}
}
{
"properties": {
"buyingRate": {
"description": "Buying price of the currency",
"type": "number",
"format": "double",
"example": 60.01
},
"sellingRate": {
"description": "Selling price of the currency",
"type": "number",
"format": "double",
"example": 60.02
},
"currencyCode": {
"description": "code of currency to be exchanged",
"type": "string",
"example": "USD"
},
"maximumSellingAmount": {
"description": "Maximum amount of currency to be sold by the bank",
"type": "number",
"format": "double",
"example": 100000.03
},
"maximumBuyingAmount": {
"description": "Maximum amount of currency to be bought by the bank",
"type": "number",
"format": "double",
"example": 100000.6
}
},
"required": [
"buyingRate",
"sellingRate",
"currencyCode"
]
}
{
"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 or detailed description of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}