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>

Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

Version of the Payment Request

Current version : 2.2

timeStamp

C 22

O

Date and time of request Message.

Format of "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

currency

C 3

M

Currency Code.

Refer to Currency Code List.

fxProvider

C 20

O

FX 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>

Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

Version of the Payment Request

Current version : 2.2

timeStamp

C 22

M

Date and time of request Message.

Format of "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

currency

C 3

M

Currency Code.

Refer to Currency Code List.

fxProvider

C 20

O

FX rate provider code.

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

Refer to Fx Provider List.

rateQuoteId

C 50

C

Fx rate quotation ID.

rateExpiryDate

C 19

C

Fx rate expiry date.

fxRate

D 15,7

M

Exchange rate from
transaction currency to merchant currency.

baseCurrency

C 3

M

Merchant base currency

responseCode

C 3

M

Response Code.

00 = success.

Response code not
00 is failed.

respReason

C 100

M

Reason of Failure

 

FX Rate List Inquiry Request Parameter


<FxRateListRequest>
    <version>2.2</version>
    <timeStamp></timeStamp>
    <merchantID></merchantID>
    <fxProvider></fxProvider>
</FxRateListRequest>

Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

Version of the payment request.

Current Version : 2.2

timeStamp

C 22

O

Date and time of request Message.

Format of "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

fxProvider

C 20

O

FX 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>

Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

Version of the Payment Request

Current version : 2.2

timeStamp

C 22

M

Date and time of request Message.

Format of "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

baseCurrency

C 3

M

Merchant base currency

fxProvider

C 20

O

FX rate provider code.

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

Refer to Fx Provider List.

currencyList

Array

O

Array of currency

currencyList.currencyCode

C 3

M

Currency Code.

Refer to Currency Code List.

currencyList.fxRate

D 15,7

M

Exchange rate from
transaction currency to merchant currency.

currencyList.rateQuoteId

C 50

C

Fx rate quotation ID.

currencyList.rateExpiryDate

C 19

C

Fx rate expiry date.

responseCode

C 3

M

Response Code.

00 = success.

Response code not
00 is failed.

respReason

C 100

M

Reason of Failure