v1

latestOpenAPI 3.0.02026-07-26355499.1 KB

Exchange Rates

Get Currency Exchange Rate

The exchange_rates endpoint allows you to get the exchange of any currency compared against USD. You need to specify a country ISO code and optionally an amount in USD. If no amount is specified, 1 USD will be assumed. Please find all the country codes in the Countries Specifications section.

get/v3/exchange_rates

Query parameters

countrystring required

Country ISO code in whose local currency the amount will be converted to. Please find all the country codes in the Countries Specifications section.

amountnumber float

Amount to convert in USD. If none is specified, 1 will be assumed.

Headers

Content-Typestring required

Media type of the body sent to the API.

X-Datestring date-time required

ISO8601 Datetime with Timezone (e.g., 2023-05-20T15:30:00Z or 2023-05-20T12:30:00-03:00).

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

Bearer token for authentication. Example: 'Bearer your_read_only_key_here'

X-Idempotency-Keystring

Unique idempotency key for ensuring that the same request is not processed more than once.

Response

Currency exchange correctly returned.

fx_ratenumber float

Currency exchange rate.

currencystring

Currency used for the conversion.

converted_amountnumber float

Amount resulting from multiplying the amount you sent with the fx_rate.