Sign in
latestOpenAPI 3.0.3UNLICENSED2026-08-2196241404.2 KB

76329919f8a7

ledger-cash deposits

Create deposit quote

Create quote for cash deposit

post/ledger/cash-deposits/quotes

Request body

payinCurrencystring required

Currency the customer pays in.

accountCurrencystring required

Currency of the account to be credited.

amountnumber required
unitCurrencystring

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

Example request

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

Response

Quote created

idstring uuid required

Unique identifier for the deposit quote.

accountCurrencystring required

Currency of the account to be credited.

payinCurrencystring required

Currency the customer pays in.

ratenumber required

Exchange rate applied for this quote

minimumAmountnumber required

Minimum amount allowed for this quote

maximumAmountnumber required

Maximum amount allowed for this quote

minimumPayinAmountnumber

Minimum pay-in amount allowed for this quote

maximumPayinAmountnumber

Maximum pay-in amount allowed for this quote

feeAmountnumber

Platform fee, in accountCurrency, already deducted from the requested transaction amount (feeInclusive is always true for a deposit — the credited amount is net of the fee). Zero when no fee applies.

feeInclusiveboolean

Always true for a deposit — the credited amount already nets out the fee.

expiresAtstring date-time required

Timestamp field.

Example response

{
  "accountCurrency": "USD",
  "payinCurrency": "NGN",
  "rate": 1450.75,
  "minimumAmount": 50,
  "maximumAmount": 10000,
  "minimumPayinAmount": 72500,
  "maximumPayinAmount": 14507500,
  "feeAmount": 0.5
}