Sign in
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.

feeAmountnumber

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.

feeInclusiveboolean

Always false for a payment — the fee was additional to amount, not deducted from it.

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,
  "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 feeAmount to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property feeInclusive to the response with the 200 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