๐ฅWithdrawals
This documentation provides an overview of the main functionalities provided by the Whirlprivacy.io platform, focusing on the withdrawal process.
โ ๏ธ You must be logged in to use these requests.
Common Headers
For all requests that require user authentication, you must include the following headers:
X-API-key
base64
API token obtained after authentication.
POST /withdrawal/init
- Initiate Withdrawal
/withdrawal/init
- Initiate WithdrawalDescription:
This endpoint initiates a withdrawal process for a user, allowing them to transfer assets out of the platform.
Parameters:
sender
String
The UUID or the label of the sender. Main by default.
No
chain
String
Blockchain chain identifier.
Yes
ticker
String
Asset ticker symbol.
Yes
amount
String
Amount of the asset to withdraw.
Yes
recipient
String
Recipient's blockchain address.
Yes
Response:
Error Handling:
E_INVALID_PARAMS
One or more request parameters are invalid.
E_UNSUPPORTED_CHAIN_ASSET
The requested chain or asset is not supported.
E_INVALID_TICKER
The provided ticker symbol is invalid.
E_INVALID_AMOUNT
The specified amount is invalid.
E_INVALID_CHAIN
The specified blockchain chain is invalid.
E_MAX_PENDING_OPS
Maximum number of pending operations exceeded.
E_BALANCE_TOO_LOW
User's balance is too low for the withdrawal.
E_ESTIMATE_FEES_OR_AMOUNT_TO_LOW
Estimated fees or amount too low for processing.
E_WITHDRAWING
Error occurred during the withdrawal initiation.
Example Code:
GET /withdrawal/history
- Get Withdrawal History
/withdrawal/history
- Get Withdrawal HistoryDescription:
This endpoint allows users to retrieve their withdrawal history.
Parameters:
uuid
or label
String
The UUID or the label of the sender.
Yes
page
Int
Specifies the page of history to fetch.
Yes
Response:
Status:
0
Withdrawal initiated
1
Withdrawal dropped
2
Withdrawal processing
3
Withdrawal failed
4
Withdrawal executed
Error Handling:
None
No specific errors defined for this route
Example Code:
Last updated