Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
FX

Get FX rates

This endpoint returns the exchange rate between two currencies. You will need to enable PERM_BUSINESS_GET_FX_RATE to use this endpoint.

get/v2/fx/rate

Query parameters

sellCurrencystring required

The currency the money is currently in

buyCurrencystring required

The currency the money is being converted to

Response

An object of FX information

providerstring

The FX transfer provider

buyCurrencystring

The currency the funds will be exchanged to

sellCurrencystring

The currency the funds are currently in

fixedSidestring

The fixed side of the FX transfer

buyAmountinteger

Amount to buy (in buy currency)

sellAmountinteger

Amount to sell (in sell currency)

rate4dinteger

Example response

{
  "provider": "TCC",
  "buyCurrency": "GBP",
  "sellCurrency": "EUR",
  "fixedSide": "SELL",
  "rate4d": 8381
}