Sign in

v3

latestOpenAPI 3.0.3UNLICENSED2026-07-2796235396.3 KB
ledger-payments

Retrieve list of cash payments

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

get/ledger/cash-payments

Query parameters

accountIdstring uuid

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

statusstring
pageinteger

Page parameter, starting from 1

sizeinteger

Response

Cash payments list

namestring

Descriptive name for the list

sizeinteger

Positive integer

totalItemsinteger

Positive integer

nextPageinteger

Positive integer

previousPageinteger

Positive integer

Example response

{
  "content": [
    {
      "currency": "USD",
      "payoutCurrency": "NGN",
      "amount": 100,
      "rate": 1450.75,
      "payoutAmount": 145075,
      "providerReference": "PROV123456",
      "recipient": {
        "accountName": "John Doe",
        "beneficiaryType": "BeneficiaryLocalBankAccount",
        "bankName": "Great Bank LLC",
        "accountIdentifier": "230101010",
        "paymentChannelId": "BANK_TRANSFER_NIGERIA",
        "country": "IE"
      }
    }
  ]
}