Skip to main content
GET
/
transfers
/
{id}
Retrieve Transfer
curl --request GET \
  --url https://{defaultHost}/transfers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "origin_ledger_account_id": "<string>",
  "destination_ledger_account_id": "<string>",
  "origin": {
    "typename": "Company",
    "id": "<string>",
    "route": "<string>",
    "title": "<string>"
  },
  "destination": {
    "typename": "Company",
    "id": "<string>",
    "route": "<string>",
    "title": "<string>"
  },
  "fee_amount": 123,
  "notes": "<string>",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

Api-Version-Date
string<date>

Pins the request to a dated API version.

Example:

"2026-07-01"

Path Parameters

id
string
required

The transfer ID.

Response

transfer retrieved

A transfer of credit between two ledger accounts.

id
string
required

Transfer ID.

amount
number
required

Transfer amount.

currency
string
required

Transfer currency.

created_at
string<date-time>
required

When the transfer was created.

origin_ledger_account_id
string
required

Source ledger account ID.

destination_ledger_account_id
string
required

Destination ledger account ID.

origin
Company · object
required

Account or user sending funds.

destination
Company · object
required

Account or user receiving funds.

fee_amount
number | null

Fee charged for the transfer.

notes
string | null

Transfer note.

metadata
object

Custom metadata attached to the transfer.