Skip to main content
POST
Queue a withdrawal to an external address.

Authorizations

Authorization
string
header
required

Session token from POST /auth/login.

Body

application/json
amount
string
required

An amount in the asset's native indivisible units.

A fixed point representation of a token or USDC amount, scaled by 1e6.

Responses encode amounts as 0x-prefixed hex strings; requests also accept decimal strings and JSON numbers.

asset
object
required
client_withdrawal_id
string<uuid>
required

Client-chosen idempotency key, unique per user. Retrying with the same id can never queue a second withdrawal.

recipient
string
required

Response

status
enum<string>
required
Available options:
Queued,
Pending,
Confirmed,
Failed,
AwaitingFunding,
PendingPayout,
Completed,
NeedsReview
withdrawal_id
string<uuid>
required

Globally unique. A replayed client_withdrawal_id returns the original id.