Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-10"

Path Parameters

id
string
required

The transfer ID.

Response

transfer retrieved

A transfer of credit between two ledger accounts.

amount
number
required

Transfer amount.

created_at
string<date-time>
required

When the transfer was created.

created_by_user
TransferCreatedByUser · object | null
required

The user who initiated the transfer, such as the team member who sent a manual payout. Null if the creator is unavailable.

currency
string
required

Transfer currency.

destination
Company · object
required

Account or user receiving funds.

destination_ledger_account_id
string
required

Destination ledger account ID.

id
string
required

Transfer ID.

object
enum<string>
required

The object type. Discriminates the create response from a send or a claim link.

Available options:
transfer
origin
Company · object
required

Account or user sending funds.

origin_ledger_account_id
string
required

Source ledger account ID.

status
enum<string>
required

Transfer status. processing means the on-chain leg is still executing — poll the transfer until it resolves to succeeded or failed.

Available options:
processing,
succeeded,
failed
fee_amount
number | null

Fee charged for the transfer.

metadata
object | null

Custom metadata attached to the transfer.

notes
string | null

Transfer note.