Withdrawal of funds
Method: POST
Route: /merchants/:merchant/wallets/:wallet/withdraw (opens in a new tab)
A payout request can only be created as a single HTTP request. If you need to send multiple payments, use the queue in your app. After successfully creating a withdrawal request, it must be confirmed or cancelled using the appropriate API methods. To approve withdrawals, you must provide a payout password in your merchant account.
Path
| Parameter | Type | Description |
|---|---|---|
merchant | String | required Merchant ID in UUIDv4 format |
wallet | String | required Wallet ID in UUIDv4 format |
Body
| Parameter | Type | Description |
|---|---|---|
amount | String | Amount to Be Sent |
address | String | Valid Crypto Address of the Recipient |
Response
| Field | Type | Description |
|---|---|---|
id | String | Confirmation ID |
confirmType | Number | Type of Confirmation Method |
attempts | Number | Confirmation Attempts |
transaction | Object | Transaction Object |
⚠️
This API endpoint is private and requires an authorization header X-Api-Key