This endpoint allows you to initiate a withdrawal from a specific address
Key | Required | Type | Description |
---|---|---|---|
assetId | true* | string (UUID) | The ID of the asset to withdraw. Required if assets array is not provided. |
address | true* | string | The destination wallet address for the withdrawal. Required if assets array is not provided. |
amount | true* | string | The withdrawal amount. Must be greater than 0. Required if assets array is not provided. |
reference | false | string | An optional reference note for the withdrawal. |
metadata | false | object | Optional metadata (key-value pairs) for additional transaction details. |
assets | true* | array of Asset | Used for batch withdrawals. Required if assetId , amount , and address are not provided. |
Key | Required | Type | Description |
---|---|---|---|
id | true | string (UUID) | The ID of the asset to withdraw. |
amount | true | string | The withdrawal amount. Must be greater than 0. |
address | true | string | The destination wallet address for the withdrawal. |
reference | false | string | Optional reference note for this asset withdrawal. |
metadata | false | object | Optional metadata (key-value pairs) for this asset withdrawal. |
Single withdrawal: Provide assetId
, amount
, and address
at the top level.
Batch withdrawal: Omit top-level assetId
, amount
, and address
, and instead provide an array of assets
(each following Asset
).
"YOUR_WALLET_ID"
"ADDRESS_ID"
200 / Multi Asset Success
The response is of type object
.