GET
Recover a transfer

Authorizations

Authorization
string
header
required

Master session from POST /v1/auth/verify. Revocable; expires after seven days by default. Required for financial operations.

Path Parameters

id
string<uuid>
required

Response

OK.

id
string<uuid>
required
client_transfer_id
string
required

Persist before the first attempt. Unique per user and resource type; reuse with other parameters returns 409 STATE_CONFLICT. When omitted, the server assigns a UUID and a lost response cannot be recovered by id.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_.:-]+$
client_take_id
string
required

Persist before the first attempt. Unique per user and resource type; reuse with other parameters returns 409 STATE_CONFLICT. When omitted, the server assigns a UUID and a lost response cannot be recovered by id.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_.:-]+$
from
string
required

A venue id from GET /v1/venues.

to
string
required

A venue id from GET /v1/venues.

amount_in
string
required

Decimal base units of the venue's token, at most 2^256 − 1. With 6 decimals, "1000000" is 1 token.

Pattern: ^[0-9]{1,78}$
min_out
string
required

Decimal base units of the venue's token, at most 2^256 − 1. With 6 decimals, "1000000" is 1 token.

Pattern: ^[0-9]{1,78}$
max_parts
integer
required
Required range: 1 <= x <= 8
payer
string
required

Responses are lowercase.

Pattern: ^0x[0-9a-fA-F]{40}$
recipient
string
required

Responses are lowercase.

Pattern: ^0x[0-9a-fA-F]{40}$
from_chain_id
integer
required
to_chain_id
integer
required
withdrawal_preparation
object | null
required
withdrawal
object | null
required
take_id
string<uuid> | null
required
take_final
boolean | null
required

True when every fill of the take is final; null before a take exists. Independent of the live fills snapshot.

cancelled_at
string<date-time> | null
required

RFC 3339 UTC; snapshots and history may keep fractional seconds.

created_at
string<date-time>
required

RFC 3339 UTC; snapshots and history may keep fractional seconds.