NEnestechops
ledger-cash deposits

Get specific cash deposit

Changed on

Get specific cash deposit by reference

get/ledger/cash-deposits/{reference}

Request

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, 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 credited amount is a tracked follow-up.

feeInclusiveboolean

The fee's intended relationship to amount once wired into settlement (true = already netted out, matching Graph USD deposits). Has no effect on amount today.

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
        }
      }
    ]
  }
}

Changes

  • 76329919f8a7Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 35fe01ca087bRevision changes
    • info

      added the optional property / to the response with the status