Sign in
ledger-transfer

Get crypto transfer by reference

This operation allows the client to fetch a specific crypto transfer by its reference ID.

get/ledger/crypto-transfer/{transferReference}

Path parameters

transferReferencestring required

The transfer unique ID

Response

Crypto Transfer fetched successfully

idstring required

Unique transaction ID

referencestring required

Unique transaction reference.

type'DEPOSIT' | 'WITHDRAWAL' | 'TRANSFER' required
amountnumber required

Transaction amount, negative for debits, positive for credits

currencystring required

Transaction 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.
categoryTagstring

Category tag for the transaction

createdDatestring date-time required

Transaction creation date

notesstring

Transaction description

accountIdstring uuid

Associated account ID

feeAmountnumber

Fee amount associated with the transaction

feeInclusiveboolean

Indicates if the fee is inclusive in the transaction amount

subAccountIdstring uuid

Associated sub-account ID, if applicable

Example response

{
  "id": "txn_123456",
  "reference": "REF123456",
  "amount": 100,
  "currency": "USD",
  "categoryTag": "crypto-withdrawal",
  "notes": "Conversion from USDC to IDR",
  "feeAmount": 1,
  "blockchainInfo": {
    "txHash": "0x093a0b443d5f698d1097368c1c05fab1ee2304e508b36c08bb72c40389c17584",
    "recipient": {
      "address": "0x2b059a574a35e60b228d10d54fec2671de4928e1",
      "memo": "1290122112"
    },
    "senderAddress": "0x2b059a574a35e60b228d10d54fec2671de4928e1",
    "blockNumber": 20564802,
    "tokenSymbol": "USDT"
  }
}

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