Create withdrawal request

Submit a withdrawal request for an asset.

The request is queued for processing and the amount will be debited from
the user's unlocked balance.

asset_id is always required. Supply either a positive decimal amount
(up to 10 decimal places), or withdraw_all: true without an amount.
Withdraw-all queues exactly one request for the selected asset's full current
unlocked balance, returning one request_id plus asset_id and the exact amount.
It does not include other assets or funds credited after submission.

Both modes reject an existing pending, queued, or requested withdrawal for the
same user and asset with 409 withdrawal_in_progress. Explicit-amount requests
retain replacement of ready requests; withdraw-all rejects ready requests too.
These checks use non-locking reads: simultaneous submissions can still race.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 50

The single asset to withdraw.

string
required

Required for fixed-amount withdrawals. A positive decimal string with at most 10 decimal places, matching the engine's on-chain precision. More than 10 fractional digits are rejected, not rounded.

boolean
enum
Defaults to false

Omit or set to false when supplying an amount.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json