Skip to content

Quotes & payments

v3 is the current version: build new integrations against it. v3 has to be enabled for your organisation; it does not come with your credentials automatically, and until it is, /v3 calls return 401 with a token that works on /v2.

Operations

Quote

Request

Create quote for use with payment.

country is also accepted as payment_country, the name POST /v3/payment uses for it.

country, payment_type and payment_method are independent enums, but only 4 of the 128 combinations they can spell between them can be paid end to end:

DestinationPayment typePayment method
India (IND)C2Cbank_transfer, instant_payment
Pakistan (PAK)C2Cbank_transfer
Nigeria (NGA)C2Cbank_transfer

B2B, B2C and C2B have no payable combination on any corridor today, and BGD, EGY, NPL, PHL and VNM cannot be paid at all. Anything outside the table either fails the quote or, where POST /v3/payment still accepts the request, fails before the payment completes — do not build against it.

Whether a listed combination is enabled for your account is a separate question, answered by the provider routes configured for it.

Security
bearerAuth
Query
timeoutnumber, [ 10 .. 120 ](Timeout)
Default:30
Bodyapplication/jsonrequired
countrystring(ApiCountry)required

Destination country. Also accepted as payment_country, the name POST /v3/payment uses for the same value.

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
payment_currencyDestinationCurrency (string) or null
Any of:

Destination currency. Informational — it is fixed by country, and is rejected if it disagrees. Filled in from country when omitted.

string(DestinationCurrency)
Enum:"BDT""INR""PKR""PHP""NPR""EGP""VND""NGN"
payment_typestring(PaymentType)required

Payment type for the quote

Enum:"B2B""B2C""C2B""C2C"
payment_methodstring(PaymentMethod)required

Payment method/rail for the quote. Not every country/payment_type/payment_method combination has a payment variant — see the table on this operation for the supported set.

Enum:"bank_transfer""cash_pickup""mobile_wallet""instant_payment"
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"
amountnumber, > 0(Amount)required

Valid amount in source or destination currency

amount_typestring(QuoteAmountType)
Default:"source"
Enum:"destination""source"
dealstring or null(Deal)
Any of:

Price this quote against an active deal instead of the live rate. The deal must cover this country, payment type and payment method, and must have room for the amount.

string (uuid)
curl -i -X POST \
  'https://docs.leanx.me/_mock/openapi/v3/quote?timeout=30' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100,
    "amount_type": "source",
    "country": "IND",
    "currency": "USD",
    "payment_method": "bank_transfer",
    "payment_type": "C2C"
  }'

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)
Default:"Quote ID"
countrystring(ApiCountry)required

Destination country

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
payment_typestring(PaymentType)required

Payment type for the quote

Enum:"B2B""B2C""C2B""C2C"
payment_methodstring(PaymentMethod)required

Payment method/rail for the quote

Enum:"bank_transfer""cash_pickup""mobile_wallet""instant_payment"
currencystring(CurrencyCode)required

Source currency

Enum:"BHD""EUR""KWD""MYR""OMR""QAR""SAR""SGD""TRY""AED"
amount_sourcenumber, > 0(Amount Source)required

Amount in the source currency

amount_destinationnumber, > 0(Amount Destination)required

Amount in the destination currency

ratenumber(Rate)required

Currency rate

timestampstring, (date-time)(Timestamp)required

Quote creation timestamp

limitsobject(QuoteLimits)
Default:"Quote limits"
wallet_infoobject(QuoteWalletInfo)required
Response
{
  "amount_destination": 8488.79,
  "amount_source": 100,
  "country": "IND",
  "currency": "USD",
  "id": "00000000-0000-7000-8000-000000000000",
  "limits": {
    "expires": "2024-12-01T01:17:03.000000Z",
    "max_amount_destination": 100000,
    "min_amount_destination": 100
  },
  "payment_method": "bank_transfer",
  "rate": 84.887912,
  "timestamp": "2024-12-01T01:02:03.000000Z",
  "wallet_info": {
    "currency": "USDT",
    "rate": 84.887912
  }
}