Get FX rates
Get the indicative foreign exchange (FX) rates for:
- <a href="https://www.checkout.com/docs/developer-resources/api/fx-rates-api#Daily_acquiring_FX_rates" target="_blank">Daily acquiring</a>
- <a href="https://www.checkout.com/docs/developer-resources/api/fx-rates-api#Scheme_acquiring_FX_rates" target="_blank">Scheme acquiring</a>
- <a href="https://www.checkout.com/docs/developer-resources/api/fx-rates-api#Card_payouts_FX_rates" target="_blank">Card payouts</a>
If you request an FX rate for a product that is not enabled for your account, you receive a 403 Forbidden error response.
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- AuthOAuth 2Client credentialsToken URLstringScopesfx
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The Checkout.com Forex product you want to get rates for.
The scheme that provided the FX rates.<br/>If product is daily_acquiring, this field is not required.
A list of <a href="https://www.checkout.com/docs/developer-resources/codes/currency-codes" target="_blank">currency code</a> pairs to retrieve FX rates for. For example, to request a rate for a USD to GBP conversion, the currency pair is USDGBP.<br/>Format – Comma-separated list
The <a href="https://www.checkout.com/docs/business-operations/use-the-dashboard/manage-processing-channels" target="_blank">processing channel's</a> unique identifier.
Response
Rates retrieved successfully
Example response
{
"product": "card_payouts",
"source": "visa",
"rates": [
{
"exchange_rate": 1.14208777,
"currency_pair": "GBPEUR"
},
{
"exchange_rate": 0.83708142,
"currency_pair": "USDGBP"
}
],
"invalid_currency_pairs": [
"XXXAAA"
]
}Changes
No recorded changes to this operation across all 1 revision of this API.