Skip to main content
Use this endpoint to initiate a withdrawal from your merchant balance to an on-chain address. You must specify the destination address, the amount to withdraw, and the payment method to use for the transfer.
Both Bearer token and API key authentication are accepted for this endpoint. API keys are scoped to a specific merchant — ensure the key matches the merchantID in the path.

​
Path parameters

​
string
required
The UUID of the merchant initiating the withdrawal.

​
Request body

​
string
required
The destination wallet address for the withdrawal. Ensure the address is valid for the selected payment method’s network.
​
string
required
The amount to withdraw as a decimal string (e.g., "50.00"). Must not exceed your available balance.
​
number
required
The ID of the payment method (network/currency) to use for the transfer.

​
Response

Returns a 201 Created with the new withdrawal object on success.
​
string
The UUID of the newly created withdrawal order.
​
string
The destination wallet address.
​
string
The withdrawal amount as a decimal string.
​
number
The ID of the payment method used for the transfer.
​
string
The current state of the withdrawal. Initial value is typically pending.
​
string
ISO 8601 timestamp of when the withdrawal was created.
​
string
The on-chain transaction hash. This field is populated once the withdrawal is broadcast to the network; it may be null immediately after creation.