Sign in
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,
      "feeAmount": 0.5,
      "providerReference": "PROV123456",
      "recipient": {
        "accountName": "John Doe",
        "beneficiaryType": "BeneficiaryLocalBankAccount",
        "bankName": "Great Bank LLC",
        "accountIdentifier": "230101010",
        "paymentChannelId": "BANK_TRANSFER_NIGERIA",
        "country": "IE"
      }
    }
  ]
}

Changes

Changed in 2 of the 6 revisions of this API.4

  • 76329919f8a72See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog