Sign in
ledger-payments

Create cash payment

Create cash payment, using the created quote

post/ledger/cash-payments

Request body

quoteIdstring uuid required

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

accountIdstring uuid required

Account to debit for this payment. Can be the main account ID or a sub-account ID.

referencestring required

Alpha-numeric transfer reference, unique for this transfer.

amountnumber required
unitCurrencystring

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

beneficiaryIdstring uuid required

Identifier of an existing beneficiary to whom the transfer will be made.

paymentReasonstring required

Reason for the payment, to be provided at the time of transfer creation.

narrationstring

Notes to be included in the transfer.

twoFaMethod'AUTHENTICATOR_APP' | 'EMAIL' | 'SMS'

Example request

{
  "reference": "CTR123456"
}

Response

Cash payment created

idstring required
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.
awaiting2fAboolean required

Indicates if transfer is awaiting 2FA confirmation. This applies mostly to transaction initiated via dashboard

twoFaMethodUser2FAMethod[]

List of 2fa enabled

Example response

{
  "id": "P12005E1DV"
}

Changes

Changed in 2 of the 6 revisions of this API.3

  • 29661adc1ffc1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • a3c4e27426152See the full diff
    • ○

      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

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