API Reference

Exchange Rate Inquiry API

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/wallet/exchangerate

This API enables cardholders to enquire about the applicable currency exchange rate, between their home country (where the card has been issued) and the acquiring bank’s country, before initiating a transaction. The Credit+ Issuing system receives, validates and processes the request. If the request is successful, the cardholder will receive the applicable exchange rate in the response. If the request fails, the system returns the corresponding error code.

HTTP Status and Response Status Matrix

  • HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
  • Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
  • Reason: This is the description of the error code returned by Credit+ Issuing application.
HTTP CodeError CodeReason
200000Successful
400997Request Parameters Validation Failure: invalid request
401990Unauthorized access.
404998Device does not exist
500993Request processing error
400EXR015User does not have permission to access this
400EXR016User does not have permission to access this
400EXR012User is not Active
400EXR013Incorrect Password
400EXR014Invalid User!
400EXR007Source Currency Not Defined
400EXR008Invalid Source Currency
400EXR009Destination Currency Not Defined
400EXR010Invalid Destination Currency
400EXR020Invalid Transaction Code
400EXR020Invalid Program Code
400EXR001Bank Currency Not Available
400EXR002Error In Fetching Bank Currency
400EXR099Conversion rate is not defined
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 50

Validation to check if the session is active and bank code must be derived from it. If incorrect or not active, reject the transaction. Not Null. Maximum length: 50.

string
length ≤ 10

Channel for which the exchange rate will be returned. Maximum length: 10.

string
enum
required
length ≤ 1

Flag used to enable the pass code. Must be Y or N. Not Null. Maximum length: 1.

Allowed:
string
length ≤ 200

Login and password given to the Acquirer ID (should be hashed with SHA5 algorithm). If passCodeFlag is Y, it should be Not NULL; else, it should be Null. Maximum length: 200.

string
required
length ≤ 3
^[0-9]{3}$

Numeric ISO currency code for source currency, that is, currency defined on the card that has to be used for transaction. Numeric. Maximum length: 3.

string
required
length ≤ 3
^[0-9]{3}$

Numeric ISO currency code for destination currency, that is, merchant’s currency. Numeric. Maximum length: 3.

string
length ≤ 2
^[A-Za-z0-9]{2}$

Transaction Codes that are supported by the Bank or Institution. Alphanumeric. Maximum length: 2.

string
length ≤ 10
^[A-Za-z0-9]+$

Program associated with the device that is to be used for transaction. Alphanumeric. Maximum length: 10.

Headers
string
^[a-zA-Z0-9-]{1,50}$

API Consumer must share a Correlation-ID in the HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

string

API Consumer can share Source in the HTTP header for API requests. For the list of Source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

Response

Updated about 1 year ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?