---
title: "Retrieve list of cash deposits"
method: GET
path: "/ledger/cash-deposits"
tags: ["ledger-cash deposits"]
---

# Retrieve list of cash deposits

`GET /ledger/cash-deposits`

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

## Query parameters

- `accountId` string, uuid
- `status` string
- `page` integer
- `size` integer

## Response `200`

Cash deposits list

- CashDepositTransactionList — Base object for paginated list
  - `name` string — Descriptive name for the list
  - `size` integer — Positive integer
  - `totalItems` integer — Positive integer
  - `nextPage` integer — Positive integer
  - `previousPage` integer — Positive integer
  - `content` CashDepositTransaction[]
    - `id` string, uuid, required
    - `reference` string, required — Reference for the cash deposit transaction at initiation.
    - `accountTransactionId` string — Identifier of the credit transaction on the account.
    - `currency` string, 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.
    - `payinCurrency` string, required — Currency the customer paid in.
    - `amount` number, required — Amount credited to the account.
    - `rate` number, required — Exchange rate applied for this deposit.
    - `payinAmount` number, required — Amount the customer paid in, in the pay-in currency.
    - `providerReference` string — Reference provided by the cash deposit provider.
    - `paymentDetails` CashDepositPaymentDetails — Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary (without an id). Carries only the account details needed to make the payment; transaction context (amount, status, etc.) lives on the enclosing CashDepositTransaction. `details` can be nullable when the account number provider is still generating it
      - `details` CashAccountDetails
        - `accountInfoType` string, required — Used to determine the exact schema type. Allowed values: - CashLocalBankAccount - CashSepaBankAccount - CashACHBankAccount - CashSwiftBankAccount - CashMobileWalletAccount - CashMultiRailBankAccount
        - `accountName` string, required — Name on the destination account.
        - `accountNumber` string, required — The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID. Where routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.
        - `reference` string — Reference the customer must include with the deposit so the pay-in is auto-matched. Optional — some providers do not require one.
      - `payinCurrency` string, required — Currency the destination account accepts for the deposit.
    - `createdDate` string, date-time, required

## Other responses

- `401` — Client is not authorized to make request

---

[API](https://skmtc.net/nestechops/apis/onboard-external-api-gateway.md) · [All operations](https://skmtc.net/nestechops/apis/onboard-external-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nestechops/onboard-external-api-gateway/revisions/29661adc1ffc/schema)