Sign in
ledger-cash deposits

Create cash deposit

Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.

post/ledger/cash-deposits

Request body

quoteIdstring uuid required

Identifier of an existing cash deposit quote, retrieved from the cash deposit quote endpoint.

accountIdstring uuid required

Account to credit for this deposit. Can be the main account ID or a sub-account ID.

referencestring required

Alpha-numeric deposit reference, unique for this deposit.

amountnumber required
unitCurrencystring

Should be same as one of pay-in or account currencies in the quote. Defaults to account currency if not provided.

narrationstring

Notes to be included with the deposit.

Example request

{
  "reference": "CTR123456"
}

Response

Cash deposit created

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

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

  • 76329919f8a72See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 35fe01ca087b1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • b633da58d08516See the full diff
    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      removed from the / response property allOf list for the response status

      response-property-all-of-removed

    • ○

      added discriminator to / response property for the response status

      response-property-discriminator-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • a3c4e2742615614See the full diff
    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became optional for the status

      response-property-became-optional

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      removed the optional property // from the response with the 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 to the / response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed discriminator from / response property for the response status

      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