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

Changes

Changed in 4 of the 6 revisions of this API.7113

  • 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

  • 35fe01ca087b1See the full diff
    • ○

      added the optional property paymentDetails/paymentMethods to the response with the 200 status

      response-optional-property-added

  • b633da58d08516See the full diff
    • ▲

      the paymentDetails/details response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property paymentDetails/details/reference to the response with the 200 status

      response-optional-property-added

    • ○

      removed CashAccountDetails from the paymentDetails/details response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      added discriminator to paymentDetails/details response property for the response status 200

      response-property-discriminator-added

    • ○

      added the required property paymentDetails/details/accountInfoType to the response with the 200 status

      response-required-property-added

    • ○

      added the required property paymentDetails/details/accountName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property paymentDetails/details/accountNumber to the response with the 200 status

      response-required-property-added

  • a3c4e2742615614See the full diff
    • ▲

      the response property paymentDetails/details became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property paymentDetails/details became optional for the status 200

      response-property-became-optional

    • ▲

      the paymentDetails/details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property paymentDetails/details/accountInfoType from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property paymentDetails/details/accountName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property paymentDetails/details/accountNumber from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property paymentDetails/details/reference from the response with the 200 status

      response-optional-property-removed

    • ○

      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

    • ○

      added CashAccountDetails to the paymentDetails/details response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed discriminator from paymentDetails/details response property for the response status 200

      response-property-discriminator-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog