NEnestechops
ledger-payments

Get specific cash payment

Changed on

Get specific cash payment by reference

get/ledger/cash-payments/{reference}

Request

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, that applied based on the business's configured fee preference (zero if none configured). Informational only for now — amount reflects only what onboard-orders actually settled and is not adjusted by this fee; wiring it into the actual debited amount is a tracked follow-up.

feeInclusiveboolean

The fee's intended relationship to amount once wired into settlement (false = additive, matching crypto withdrawals). Has no effect on amount today.

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",
    "paymentChannelName": "Bank transfer",
    "country": "IE"
  }
}

Changes

  • 9865a7269424Revision changes
    • info

      added the optional property / to the response with the status

  • 76329919f8a7Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status