Get Quote ID

get

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

Gets the exchange rate between two currencies with Quote Id to be used in the transaction uniquely.

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

required

length ≥ 1

Receiving country. (Required)

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

required

length ≥ 1

Receiving agent 6-character code. (Required)

payoutCurrency

string

required

length ≥ 1

ISO Currency Code. (Required)

Format: ISO-4217 alpha-3 code (Optional). If country code is set, currency code is mandatory

sendAmount

double

Source Amount. (Optional)

Amount sent in the settlement currency.

targetAmount

double

Target Amount. (Optional)

Amount the recipient should receive in the payout currency.

correlationId

string | null

Correlation ID. (Optional)

Request correlation reference used for tracing.

userId

string | null

User ID. (Optional)

User/requestor identifier.

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-agent-user-id

string

\w{1,15}

This is the user code provided to the agent by the IC Operations department.

x-agent-user-password

string

Password shared by IC Operations department.

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

200OK

400Bad Request

500Internal Server Error

503Service Unavailable