Checkout.com API logo

Forex

Use the Forex API to access Checkout.com's foreign exchange (FX) services.

Get FX rates

Get the indicative foreign exchange (FX) rates for:

If you request an FX rate for a product that is not enabled for your account, you receive a 403 Forbidden error response.

SecurityOAuth2: OAuth
Request
query Parameters
product
required
string (ForexProduct)

The Checkout.com Forex product you want to get rates for.

Enum: "card_payouts" "daily_acquiring" "scheme_acquiring"
Example: product=card_payouts
source
required
string (ForexSource)

The scheme that provided the FX rates.
If product is daily_acquiring, this field is not required.

Enum: "mastercard" "visa"
Example: source=visa
currency_pairs
required
string

A list of currency code pairs to retrieve FX rates for. For example, to request a rate for a USD to GBP conversion, the currency pair is USDGBP.
Format – Comma-separated list

Example: currency_pairs=USDGBP,EURNOK,JPYCAD
processing_channel_id
required
string (ForexProcessingChannelId) ^(pc)_(\w{26})$

The processing channel's unique identifier.

Example: processing_channel_id=pc_vxt6yftthv4e5flqak6w2i7rim
Responses
200

Rates retrieved successfully

401

Unauthorized

403

Forbidden

422

Unprocessable Content

429

Too Many Requests / Duplicate Requests

502

Bad Gateway

get/forex/rates
Request samples 
Response samples 
application/json
{
  • "product": "card_payouts",
  • "source": "visa",
  • "rates": [
    ],
  • "invalid_currency_pairs": [
    ]
}
➔ Next to Apple Pay