Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-20"

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.

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.

origin
Company · object
required

Account or user sending funds.

origin_ledger_account_id
string
required

Source ledger account ID.

fee_amount
number | null

Fee charged for the transfer.

metadata
object | null

Custom metadata attached to the transfer.

notes
string | null

Transfer note.