Get Quote

get

https://sandbox-api.readyremit.com/v1/quote

The GET /quote endpoint provides a real-time quote for a money transfer. By specifying the source currency, transfer corridor, transfer method, and sender amount, this operation returns a detailed breakdown of the estimated transfer cost and recipient amount.

Implementation Guide:

Prerequisite: Ensure that all required parameters are provided to calculate the quote accurately.
The quote calculation may vary based on the transfer details such as source and destination countries, currencies, and transfer method. Always retrieve a fresh quote before initiating a transfer, as rates and fees may change.
Quotes are time-sensitive and reflect the exchange rate at the moment of retrieval. Rates may fluctuate between the quote request and the actual transfer.

Query Params

dstCountryIso3Code

string

required

length between 3 and 3

The ISO 3166-1 alpha-3 code of the destination country. See country codes. Example- MEX

dstCurrencyIso3Code

string

required

length between 3 and 3

The ISO 4217 code of the currency of the amount you would like to receive money. A string of exactly 3 uppercase alphabetical characters. See currency codes.

srcCurrencyIso3Code

string

required

length between 3 and 3

The ISO 4217 code of the currency of the amount you would like to send money. A string of exactly 3 uppercase alphabetical characters. See currency codes.

transferMethod

string

enum

required

Defaults to BANK_ACCOUNT

The method used for transferring money. eg - Bank Account, Cash Pickup, Push to Card. See Transfer Method.

Allowed:

quoteBy

string

enum

required

Defaults to SEND_AMOUNT

This parameter determines how the quote is calculated, based on either the sender amount or the recipient amount. It helps in providing an accurate estimate for the transfer. See quoteBy. Example: "SEND_AMOUNT"

Allowed:

amount

number

required

Numeric value. The amount the sender wishes to transfer. Example- If you want to send 100 USD, this would be 10000. See how to format an amount based on the currency you would like to send or receive money.

Responses

200The quote was successfully retrieved.

400The request was invalid. This response typically occurs if required parameters are missing or invalid.

401The request requires user authentication. This response occurs if the authentication token is missing or invalid.

404The quote could not be retrieved. This response occurs if the parameters provided do not match any available quotes.