Sign in
ledger-transfer

Create internal transfer

This operation allows the client to create an internal transfer between subaccounts and main account.

post/ledger/internal-transfers

Request body

sourceAccountIdstring uuid required

Source account ID, could be the main account or another sub-account

destinationAccountIdstring uuid required

Destination account ID, could be the main account or another sub-account

referencestring

Alpha-numeric transfer reference

amountnumber required

Transfer amount

notesstring

Transfer description

Example request

{
  "reference": "ITR123456",
  "amount": 100
}

Response

Internal transfer created successfully

referencestring required

Transfer reference

sourceAccountIdstring uuid required

Source account ID

sourceAccountRefstring

The transaction reference on the source account.

destinationAccountIdstring uuid required

Destination account ID

destinationAccountRefstring

The transaction reference on the destination account.

amountnumber required

Transfer amount

currencystring required

Transfer currency

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.
createdDatestring date-time required

Transfer creation date

descriptionstring

Transfer description

Example response

{
  "reference": "ITR123456",
  "amount": 100,
  "currency": "USD"
}

Changes

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

  • 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