post
https://{BASE_URL_PROD}/v4/withdraw/private/create
Method for assets withdraw (crypto and fiat). Returns withdraw Id and Status.
This is a private route, so the api-key parameter should be sent in the header.
Data dictionary
| Name | Type | Parameter type | Required | Range | Description |
|---|---|---|---|---|---|
| currency | string | BODY | YES | - | Currency to withdraw (crypto or fiat) |
| address | string | BODY | NO | - | Withdraw address for crypto |
| paymentId | string | BODY | NO | - | Field for withdraw identifier memo / tag / paymentId identifier |
| paymentMethod | string | BODY | YES | - | Withdraw method for currency, shuould be taken from GET preRequest API |
| withdrawAll | boolean | BODY | NO | - | Flag for withdraw all funds with commission included |
| amount | number | BODY | YES | - | withdraw amount |
>
Response structure
You will receive a JSON in the response with data object, containing withdraw id and status, structured like this example:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"data": "{
"id": "edb17459-c9bf-4148-9ae6-7367d7f55d71" // Unique identifier of a withdraw
"status": "waitingForConfirmation" // status of a withdraw
}",
}