Transfers
Retrieve Transfer
Retrieves a single transfer.
get/transfers/{id}
Response
transfer retrieved
amountnumber required
Transfer amount.
created_atstring date-time required
When the transfer was created.
currencystring required
Transfer currency.
destination_ledger_account_idstring required
Destination ledger account ID.
fee_amountnumber nullable
Fee charged for the transfer.
idstring required
Transfer ID.
metadataobject nullable
Custom metadata attached to the transfer.
notesstring nullable
Transfer note.
object'transfer' required
The object type. Discriminates the create response from a send or a claim link.
origin_ledger_account_idstring required
Source ledger account ID.
status'processing' | 'succeeded' | 'failed' required
Transfer status. processing means the on-chain leg is still executing — poll the transfer until it resolves to succeeded or failed.