FX Rate / FX Rate List Inquiry API

๐Ÿ“˜

Data Attribute Reference

Data Type

  • A: Alphabet
  • AN: Alphanumeric
  • C: Characters
  • B: Boolean
  • D: Decimal
  • N: Numeric

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional

ย 

FX Rate Inquiry Request Parameters


<FxRateRequest>
    <version>2.2</version>
    <timeStamp></timeStamp>
    <merchantID></merchantID>
    <currency></currency>
    <fxProvider></fxProvider>
</FxRateRequest>
ParameterData Type / LengthMandatoryDescription
versionC 5MVersion of the Payment Request

Current version : 2.2
timeStampC 22ODate and time of request Message.

Format of "ddMMyyHHmmss"
merchantIDC 15MMerchant ID
currencyC 3MCurrency Code.

Refer to Currency Code List.
fxProviderC 20OFX rate provider code.

If provider is not passed in, primary profile fx provider will be used as default.

Refer to Fx Provider List.

ย 

FX Rate Inquiry Response Parameter


<FxRateResponse>
    <version>2.2</version>
    <timeStamp></timeStamp>
    <merchantID></merchantID>
    <currency></currency>
    <fxProvider></fxProvider>
    <rateQuoteID></rateQuoteId>
    <rateExpiryDate></rateExpiryDate>
    <fxRate></fxRate>
    <baseCurrency></baseCurrency>
    <responseCode></responseCode>
    <respReason></respReason>
</FxRateResponse>
ParameterData Type / LengthMandatoryDescription
versionC 5MVersion of the Payment Request

Current version : 2.2
timeStampC 22MDate and time of request Message.

Format of "ddMMyyHHmmss"
merchantIDC 15MMerchant ID
currencyC 3MCurrency Code.

Refer to Currency Code List.
fxProviderC 20OFX rate provider code.

If provider is not passed in, primary profile fx provider will be used as default.

Refer to Fx Provider List.
rateQuoteIdC 50CFx rate quotation ID.
rateExpiryDateC 19CFx rate expiry date.
fxRateD 15,7MExchange rate from
transaction currency to merchant currency.
baseCurrencyC 3MMerchant base currency
responseCodeC 3MResponse Code.

00 = success.

Response code not
00 is failed.
respReasonC 100MReason of Failure

ย 

FX Rate List Inquiry Request Parameter


<FxRateListRequest>
    <version>2.2</version>
    <timeStamp></timeStamp>
    <merchantID></merchantID>
    <fxProvider></fxProvider>
</FxRateListRequest>
ParameterData Type / LengthMandatoryDescription
versionC 5MVersion of the payment request.

Current Version : 2.2
timeStampC 22ODate and time of request Message.

Format of "ddMMyyHHmmss"
merchantIDC 15MMerchant ID
fxProviderC 20OFX rate provider code.

If provider is not passed in, primary profile fx provider will be used as default.

Refer to Fx Provider List.

ย 

FX Rate List Inquiry Response Parameter


<FxRateListResponse>
    <version>2.2</version>
    <timeStamp></timeStamp>
    <merchantID></merchantID>
    <baseCurrency></baseCurrency>
    <fxProvider></fxProvider>
    <currencyList>
        <currency currencyCode="" fxRate="" rateQuoteId="" rateExpiryDate="" />
        <currency currencyCode="" fxRate="" rateQuoteId="" rateExpiryDate="" />
    </currencyList>
    <responseCode></responseCode>
    <respReason></respReason>
</FxRateListResponse>
ParameterData Type / LengthMandatoryDescription
versionC 5MVersion of the Payment Request

Current version : 2.2
timeStampC 22MDate and time of request Message.

Format of "ddMMyyHHmmss"
merchantIDC 15MMerchant ID
baseCurrencyC 3MMerchant base currency
fxProviderC 20OFX rate provider code.

If provider is not passed in, primary profile fx provider will be used as default.

Refer to Fx Provider List.
currencyListArrayOArray of currency
currencyList.currencyCodeC 3MCurrency Code.

Refer to Currency Code List.
currencyList.fxRateD 15,7MExchange rate from
transaction currency to merchant currency.
currencyList.rateQuoteIdC 50CFx rate quotation ID.
currencyList.rateExpiryDateC 19CFx rate expiry date.
responseCodeC 3MResponse Code.

00 = success.

Response code not
00 is failed.
respReasonC 100MReason of Failure