v3

latestOpenAPI 3.0.3UNLICENSED2026-07-2796235396.3 KB

ledger-payments

Get specific cash payment

Get specific cash payment by reference

get/ledger/cash-payments/{reference}

Path parameters

referencestring required

Response

cash payment details

idstring uuid required

referencestring required

Reference for the cash payment transaction at initiation.

accountTransactionIdstring

Identifier of the transaction on the account.

currencystring 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.

payoutCurrencystring required

Currency in which the beneficiary will be paid out.

amountnumber required

Amount transferred.

ratenumber required

Exchange rate applied for this transfer.

payoutAmountnumber required

Amount paid out to the beneficiary in payout currency.

providerReferencestring

Reference provided by the cash payment provider.

createdDatestring date-time required

Example response

{
  "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"
  }
}