Sign in
ledger-transfer

Get internal transfer by reference

This operation allows the client to fetch an internal transfer by its reference ID.

get/ledger/internal-transfers/{referenceId}

Path parameters

referenceIdstring required

The transaction or transfer reference ID

Response

Internal transfer fetched 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