Sign in

v3

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

Retrieve list of cash deposits

Retrieve a list of cash deposits, can accept accountId, status

get/ledger/cash-deposits

Query parameters

accountIdstring uuid

Filter by the account that was credited. Can be the main account ID or a sub-account ID.

statusstring
pageinteger

Page parameter, starting from 1

sizeinteger

Response

Cash deposits list

namestring

Descriptive name for the list

sizeinteger

Positive integer

totalItemsinteger

Positive integer

nextPageinteger

Positive integer

previousPageinteger

Positive integer

Example response

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