Sign in
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 — subscribe to transfer.completed and transfer.failed, or retrieve the transfer to check its current status. 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"
}

Changes

Changed in 5 of the 74 revisions of this API.7

  • c301132dbfd73See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c970f803b461See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bdd0e2c70d581See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8d1ddeb8dc331See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

Of the 74 revisions, 1 has no diff computed.