NEnestechops
ledger-cash deposits

Create deposit quote

Changed on

Create quote for cash deposit

post/ledger/cash-deposits/quotes

Request

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, that would apply based on the business's configured fee preference (zero if none configured). Informational only for now — not yet reflected in minimumAmount/maximumAmount or in the amount actually credited once the deposit settles; wiring it into the settled amount is a tracked follow-up.

feeInclusiveboolean

The fee's intended relationship to the credited amount once wired into settlement (true = already netted out, matching Graph USD deposits). Has no effect on the credited amount today.

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
}

Changes

  • 76329919f8a7Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • a3c4e2742615Revision changes
    • info

      the endpoint scheme security HMACAuth was added to the API

    • info

      the endpoint scheme security authToken was removed from the API