Sign in
latestOpenAPI 3.0.3UNLICENSED2026-08-2196241404.2 KB

76329919f8a7

ledger-payments

Create transfer quote

Create quote for cash payment

post/ledger/cash-payments/quotes

Request body

payoutCurrencystring required

Currency of the payout to the beneficiary.

accountCurrencystring required

Currency of the account to be debited.

amountnumber required
unitCurrencystring

Should be same as one of payout or account currencies. Defaults to account currency if not provided.

Example request

{
  "payoutCurrency": "NGN",
  "accountCurrency": "USD",
  "amount": 100,
  "unitCurrency": "USD"
}

Response

Quote created

idstring uuid required

Unique identifier for the transfer quote.

accountCurrencystring required

Currency of the account to be debited.

payoutCurrencystring required

Currency of the payout to the beneficiary.

ratenumber required

Exchange rate applied for this quote

minimumAmountnumber required

Minimum amount allowed for this quote

maximumAmountnumber required

Maximum amount allowed for this quote

minimumPayoutAmountnumber

Minimum payout amount allowed for this quote

maximumPayoutAmountnumber

Maximum payout amount allowed for this quote

feeAmountnumber

Platform fee, in accountCurrency, charged in addition to the requested transaction amount (feeInclusive is always false for a payment — the account is debited requested amount + feeAmount). Zero when no fee applies.

feeInclusiveboolean

Always false for a payment — the fee is additional to the requested transaction amount, not deducted from it.

expiresAtstring date-time required

Timestamp field.

Example response

{
  "accountCurrency": "USD",
  "payoutCurrency": "NGN",
  "rate": 1450.75,
  "minimumAmount": 50,
  "maximumAmount": 10000,
  "minimumPayoutAmount": 72500,
  "maximumPayoutAmount": 14507500,
  "feeAmount": 0.5
}