Get Exchange Rate

get

https://api.instantcashworldwide.ae/sandbox/api/v1/rates

Gets the exchange rate between two currencies or return all exchange rates available for a sending agent.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sendingAgent

string

required

length ≥ 1

Sending agent 6-character code. (Required)

settlementCurrency

string

required

length ≥ 1

Local currency of sending agent. (Required)

Format: ISO-4217 alpha-3 code

destinationCountry

string | null

Receiving country. (Optional)

If the value is blank, system will return exchange rates for all available countries.
Else, it will return exchange rate for a specific country only.
Format: ISO-3166 alpha-2 code

receivingAgent

string | null

Receiving agent 6-character code. (Optional)

Headers

x-fapi-financial-id

string

required

^[A-Z]{2}[0-9A-Z]{4}$

This is the agent correspondent id provided to the agent by the IC Operations department. It is used to facilitate API management and auditing.

x-correlation-id

string

\w{8}-\w{4}-\w{4}-\w{4}-\w{12}

This header is used to uniquely identify the HTTP request and to facilitate troubleshooting.

x-idempotency-key

string

\w{8}-\w{4}-\w{4}-\w{4}-\w{12}

Unique request identifier to support idempotency. You may generate (UUID v4) value using the programming language.

Responses

200Success

400Bad Request

500Server Error

503Server Error