Create a withdrawal

Create a withdrawal from the authenticated integrator's main wallet. amount is the normal asset quantity; do not convert it to the asset's smallest unit. Use Get withdrawal networks to select a supported network.
Most successful requests return a withdrawal ID with a pending status and continue asynchronously. When a webhook URL is configured, OneLiquidity can send WALLET_WITHDRAWAL_PROCESSING, WALLET_WITHDRAWAL_COMPLETED, WALLET_WITHDRAWAL_FAILURE, WALLET_WITHDRAWAL_REJECTED, WALLET_WITHDRAWAL_CANCELLED, or WALLET_WITHDRAWAL_REFUNDED.
When your account requires invited-user approval, the API can instead return HTTP 202 with an approval request. No withdrawal has executed at that point.

Body Params

Withdrawal details.

string
required

Asset code for the main wallet to debit.

number
required
> 0

Positive withdrawal quantity in normal asset units, not the asset's smallest unit.

string
required

Destination blockchain address.

string
required

Supported blockchain network for the selected asset and destination address.

string

Destination memo or tag when required by the network.

string

Optional reference or description for the withdrawal.

string
deprecated

Deprecated legacy field. It is ignored and should not be sent.

string
deprecated

Deprecated legacy field. It is ignored and should not be sent.

Headers
string
length ≤ 200

Strongly recommended stable key for this logical withdrawal when an invited-user policy can route the request for approval.

Responses

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