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

# Retrieve list of cash payments

`GET /ledger/cash-payments`

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

## Query parameters

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

## Response `200`

Cash payments list

- CashPaymentTransactionList — 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` CashPaymentTransaction[]
    - `id` string, uuid, required
    - `reference` string, required — Reference for the cash payment transaction at initiation.
    - `accountTransactionId` string — Identifier of the transaction on the account.
    - `currency` string, required — Currency in which the account was debited.
    - `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.
    - `payoutCurrency` string, required — Currency in which the beneficiary will be paid out.
    - `amount` number, required — Amount transferred.
    - `rate` number, required — Exchange rate applied for this transfer.
    - `payoutAmount` number, required — Amount paid out to the beneficiary in payout currency.
    - `feeAmount` number — Platform fee, in currency, that applied based on the business's configured fee preference (zero if none configured). Informational only for now — amount reflects only what onboard-orders actually settled and is not adjusted by this fee; wiring it into the actual debited amount is a tracked follow-up.
    - `feeInclusive` boolean — The fee's intended relationship to amount once wired into settlement (false = additive, matching crypto withdrawals). Has no effect on amount today.
    - `providerReference` string — Reference provided by the cash payment provider.
    - `recipient` BasicBeneficiaryInfo, required — Basic information about a beneficiary as at the time of transaction.
      - `id` string, uuid, required — Unique identifier for the beneficiary.
      - `accountName` string, required — Name on the account
      - `beneficiaryType` string, required — Type of beneficiary object.
      - `bankName` string — Name of the receiving bank, for mobile money this would be the network, and for P2P wallet it will be the name of the account provider
      - `accountIdentifier` string, required — The account identifier at the bank. For mobile money, this is the phone number on account, for P2P wallet, this is the account ID Where routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`
      - `paymentChannelId` string, required — Identifier of the payment channel used for this transaction, if available. This can be used to determine the exact payment method used for the transaction.
      - `country` string — Country where the payment method belongs if available
    - `createdDate` string, date-time, required

## Other responses

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

## Changes

- **2026-08-21** `76329919f8a7` — 2 info
  - added the optional property `allOf[subschema #2]/content/items/feeAmount` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/content/items/feeInclusive` to the response with the `200` status
- **2026-07-26** `a3c4e2742615` — 2 info
  - the endpoint scheme security `HMACAuth` was added to the API
  - the endpoint scheme security `authToken` was removed from the API

[Change history](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/changes/ledger/cash-payments/get.md)

---

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