---
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, charged in addition to amount (feeInclusive is always false for a payment — the account was debited amount + feeAmount). Zero when no fee applied.
    - `feeInclusive` boolean — Always false for a payment — the fee was additional to amount, not deducted from it.
    - `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

---

[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/76329919f8a7/schema)