List live FX rates

get

https://sandbox.numeral.io/v1/live_fx_rates

Returns the live FX rates the provider of a connected account quotes for a currency pair.

Each call requests the rates from the provider. Cache the rates until valid_until rather than calling this endpoint before each payment order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

connected_account_id

uuid

required

ID of the connected account to get the rates for. The connected account must be configured for live FX rates.

symbol

string

required

Currency pair, written <base currency>/<quote currency> with two different ISO 4217 codes. URL-encode the / as %2F.

Write the pair in market order: EUR/USD, not USD/EUR. The base currency is the first of the two in this order: EUR, GBP, AUD, NZD, USD, CAD, CHF, NOK, SEK, JPY. Pairs of two other currencies are written in alphabetical order, e.g. MXN/ZAR. A pair in the wrong order returns a validation error with the expected spelling.

Case-insensitive. The response returns the pair in upper case.

recipient_instrument_type

string

Payout instrument to get the rates for. Omit to get the rates for all payout instruments.

bank_account – Payout to a bank account.
wallet – Payout to a digital wallet.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

429The provider rate-limited the request. The error message says how many seconds to wait before retrying (between 1 and 3600).

500Internal server error.

503Live FX rates are not available on this environment.