Skip to content
/
Quote

Quote

Request

Create quote for use with payment

Security
bearerAuth
Bodyapplication/jsonrequired
Any of:

Send amount to fix the source amount, or amount_destination to fix the payout amount.

countrystring(ApiCountry)required

Destination country

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
currencystring(CurrencyCode)required

Source currency. Which currencies you can use depends on the exchange rates configured for your account and this corridor; a currency without a rate returns no quote.

Enum:"BHD""EUR""KWD""MYR""OMR""QAR""SAR""SGD""TRY""AED"
beneficiary_account_numberstring or null(Beneficiary Account Number)
Any of:

Bank account id of the beneficiary. [OPTIONAL]

string
bank_branch_codestring or null(Bank Branch Code)
Any of:

Bank branch code of the beneficiary (e.g. IFSC for India) [OPTIONAL]

string
amountnumber, > 0(Amount)required

The amount to convert, in the SOURCE currency - the one named in currency (e.g. AED, USD), not the destination country's. Rounded to 4 decimal places.

curl -i -X POST \
  https://docs.leanx.me/_mock/openapi/v2/quote \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "country": "BGD",
    "currency": "BHD",
    "beneficiary_account_number": "string",
    "bank_branch_code": "string",
    "amount": 1
  }'

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required

Quote id. Send it as quote on POST /v2/payment; a quote can back one payment only.

countrystring(ApiCountry)required

Destination country.

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
currencystring(CurrencyCode)required

Source currency, the one amount is in.

Enum:"BHD""EUR""KWD""MYR""OMR""QAR""SAR""SGD""TRY""AED"
amountnumber(Amount)required

What you pay, in the source currency.

amount_destinationnumber(Amount Destination)required

What the beneficiary receives, in the destination currency. Send it verbatim as amount on POST /v2/payment.

ratenumber(Rate)required

Exchange rate from the source currency to the destination currency. This is the rate your customer sees.

timestampstring, (date-time)(Timestamp)required

When the quote was issued (UTC).

expiresstring, (date-time)(Expires)required

When the quote stops being usable (UTC), currently 15 minutes after timestamp. Read this value rather than hard-coding the window.

wallet_ratenumber(Wallet Rate)required

Exchange rate from your settlement wallet currency to the destination currency. For settlement only: do not show it to your customer or use it to compute a payout.

min_amount_destinationnumber or null(Min Amount Destination)
Any of:

Smallest payout your account may send on this corridor, in the destination currency. Set per account, so read it from every quote rather than caching it.

number
max_amount_destinationnumber or null(Max Amount Destination)
Any of:

Largest payout your account may send on this corridor, in the destination currency. Set per account, so read it from every quote rather than caching it.

number
Response
{
  "amount": 100,
  "amount_destination": 8488.79,
  "country": "IND",
  "currency": "USD",
  "expires": "2024-12-01T01:17:03.000000Z",
  "id": "00000000-0000-4000-A000-000000000000",
  "max_amount_destination": 100000,
  "min_amount_destination": 100,
  "rate": 84.887912,
  "timestamp": "2024-12-01T01:02:03.000000Z",
  "wallet_rate": 84.887912
}