๐Disperse
This documentation provides details on the API endpoints available for Whirlprivacy.io, focusing on disperse-related operations.
โ ๏ธ You must be logged in to use these requests.
Common Headers
For all requests that require user authentication, you must include the following headers:
Header Name | Value | Description |
---|---|---|
X-API-key |
| API token obtained after authentication. |
POST /disperse/init
โ Disperse Init
/disperse/init
โ Disperse InitDescription:
Allows a logged-in user to initiate a disperse operation. It is designed to distribute an asset across multiple addresses, optionally incorporating a delay in the disbursement process.
Parameters:
Name | Type | Description | Required |
---|---|---|---|
| String | The UUID or the label of the sender. Main by default. | No |
| String | The blockchain chain ID where the asset exists. | Yes |
| String | The ticker symbol of the asset to disperse. | Yes |
| Array | A list of recipient objects with | Yes |
| Integer | The minimum delay (in minutes) before the disperse starts. | No |
| Integer | The maximum delay (in minutes) after which the disperse must occur. | No |
Request Example:
Response:
Error Handling:
Error Code | Description |
---|---|
| One or more parameters are missing or invalid. |
| The specified delay is invalid. |
| The specified chain or asset is not supported. |
| The number of recipients exceeds the maximum allowed. |
| The specified ticker symbol is not recognized. |
| The specified chain ID is invalid. |
| The user has exceeded the maximum number of pending operations. |
| One or more of the specified amounts are invalid. |
| One or more of the recipient addresses are invalid. |
| The user's balance is too low to complete the disperse. |
| Estimated fees are too high or the amount is too low. |
| An error occurred during the disperse initiation. |
Example Code:
Last updated