Sign in
latestOpenAPI 3.1.02026-08-153864115.7 MB

c301132dbfd7

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.

failed_atstring date-time nullable

When the transfer failed, as an ISO 8601 timestamp. Null unless the transfer has failed.

failure_codestring nullable

Machine-readable code for why the transfer failed. Null unless the transfer has failed.

failure_reasonstring nullable

Human-readable explanation of why the transfer failed. Null unless the transfer has failed.

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. A failed transfer may be retried under the same ID and later resolve to succeeded.

Example response

{
  "amount": 25,
  "created_at": "2026-01-01T12:00:00.000Z",
  "created_by_user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Marcus Webb",
    "username": "marcuswebb"
  },
  "currency": "usd",
  "destination": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing",
    "typename": "Company"
  },
  "destination_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
  "fee_amount": 0.5,
  "id": "ctt_xxxxxxxxxxxxxx",
  "metadata": {
    "order_id": "SHINE-1042"
  },
  "notes": "Refund for the rescheduled interior detail",
  "object": "transfer",
  "origin": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing",
    "typename": "Company"
  },
  "origin_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
  "status": "succeeded"
}