Sign in

v3

latestOpenAPI 3.0.3UNLICENSED2026-07-2796235396.3 KB
ledger-cash deposits

Create cash deposit

Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.

post/ledger/cash-deposits

Request body

quoteIdstring uuid required

Identifier of an existing cash deposit quote, retrieved from the cash deposit quote endpoint.

accountIdstring uuid required

Account to credit for this deposit. Can be the main account ID or a sub-account ID.

referencestring required

Alpha-numeric deposit reference, unique for this deposit.

amountnumber required
unitCurrencystring

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

narrationstring

Notes to be included with the deposit.

Example request

{
  "reference": "CTR123456"
}

Response

Cash deposit created

idstring uuid required
referencestring required

Reference for the cash deposit transaction at initiation.

accountTransactionIdstring

Identifier of the credit transaction on the account.

currencystring required

Currency in which the account was credited.

status'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'SUCCESS' required

Status of the transaction, indicating its current state in the processing lifecycle.

  • PENDING: The transaction has been created but not yet processed.
  • IN_PROGRESS: The transaction is currently being processed.
  • FAILED: The transaction processing has failed.
  • SUCCESS: The transaction has been successfully processed.
payinCurrencystring required

Currency the customer paid in.

amountnumber required

Amount credited to the account.

ratenumber required

Exchange rate applied for this deposit.

payinAmountnumber required

Amount the customer paid in, in the pay-in currency.

providerReferencestring

Reference provided by the cash deposit provider.

createdDatestring date-time required

Example response

{
  "currency": "USD",
  "payinCurrency": "NGN",
  "amount": 100,
  "rate": 1450.75,
  "payinAmount": 145075,
  "providerReference": "PROV123456",
  "paymentDetails": {
    "details": {
      "accountName": "John Doe",
      "accountNumber": "230101010",
      "reference": "PROV123456"
    },
    "payinCurrency": "NGN"
  }
}