SchemaPaymentsCurrency Conversion

Fx rates inquiry

Check if a customer’s card is eligible for Dynamic Currency Conversion (DCC). If the card is eligible for DCC, offer currency conversion to the customer during a transaction.
Note: We offer this through the DCC service, which gives customers a choice to pay in the local currency or their own currency.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
channelenumRequired

Channel that the merchant used to receive payment details for the transaction.

Allowed values:
processingTerminalIdstringRequired>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

baseAmountlongRequired

Total amount of the transaction in the local currency. The value is in the currency’s lowest denomination, for example, cents.

baseCurrencyenumRequired

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

paymentMethodobjectRequired

Object that contains information about the customer’s payment details.

operatorstringOptional>=1 character<=50 characters

Operator who ran the transaction.

Response

Successful request. Returns the currency conversion rate for the transaction.

processingTerminalIdstring>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

baseAmountlong

Total amount of the transaction in the local currency. The value is in the currency’s lowest denomination, for example, cents.

baseCurrencyenum

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

inquiryResultobject

Object that contains information about the currency conversion rate.

cardInfoobject

Object that contains information about the card.

operatorstringOptional>=0 characters<=50 characters

Operator who ran the transaction.

dccOfferobjectOptional

Object that contains the exchange rates offer for a foreign card.