Sign in
latestOpenAPI 3.0.3UNLICENSED2026-08-2196241404.2 KB

76329919f8a7

ledger-cash deposits

Get specific cash deposit

Get specific cash deposit by reference

get/ledger/cash-deposits/{reference}

Path parameters

referencestring required

Response

cash deposit details

idstring uuid required
referencestring required

Reference for the cash deposit transaction at initiation.

accountTransactionIdstring

Identifier of the credit transaction on the account.

currencystring required

Currency in which the account was credited.

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.
payinCurrencystring required

Currency the customer paid in.

amountnumber required

Amount credited to the account.

ratenumber required

Exchange rate applied for this deposit.

payinAmountnumber required

Amount the customer paid in, in the pay-in currency.

feeAmountnumber

Platform fee, in currency, already deducted from amount (feeInclusive is always true for a deposit — amount is the net amount credited after the fee). Zero when no fee applied.

feeInclusiveboolean

Always true for a deposit — amount already nets out the fee.

providerReferencestring

Reference provided by the cash deposit provider.

createdDatestring date-time required

Example response

{
  "currency": "USD",
  "payinCurrency": "NGN",
  "amount": 100,
  "rate": 1450.75,
  "payinAmount": 145075,
  "feeAmount": 0.5,
  "providerReference": "PROV123456",
  "paymentDetails": {
    "details": {
      "accountName": "John Doe",
      "accountNumber": "230101010",
      "reference": "PROV123456"
    },
    "payinCurrency": "NGN",
    "paymentMethods": [
      {
        "fee": {
          "percentage": 0.0035,
          "fixedAmount": 1.5,
          "currency": "USD"
        },
        "limits": {
          "minAmount": 1,
          "firstParty": {
            "maxPerTransaction": 250000,
            "maxPerDay": 24000
          },
          "thirdParty": {
            "maxPerTransaction": 250000,
            "maxPerDay": 24000
          },
          "currency": "USD"
        },
        "timeline": {
          "minValue": 1,
          "maxValue": 3
        }
      }
    ]
  }
}