โก๏ธTransfer
This documentation provides details on the API endpoints available for Whirlprivacy.io, focusing on transfer-related operations.
POST /transfer/init
- Initiate Transfer
/transfer/init
- Initiate TransferDescription: Initiates a virtual transfer between two accounts, either from UUID to UUID or from UUID to a recipient address.
Parameters:
Parameter | Type | Description |
---|---|---|
| string | The asset ticker symbol. |
| string | The amount of the asset to transfer. |
| string | The UUID of the sender's virtual account. |
| string | The recipient's address or UUID. |
| string | An optional label for the sender's virtual account. |
| string | Optional fees to be applied to the transaction. |
| string | The collector of the transaction fees. |
Response:
Error Handling:
Error Code | Description |
---|---|
| Returned if required parameters are missing or invalid. |
| Invalid or unsupported ticker symbol. |
| Invalid transaction amount, possibly below minimum threshold. |
| Specified fees are greater than the transaction amount. |
| Fees collector address is invalid or not found. |
| General error during the transfer initiation process. |
Example Code:
GET /transfer/history/sent
- Sent Transfer History
/transfer/history/sent
- Sent Transfer HistoryDescription: Retrieves the history of all transfers sent from the user's virtual accounts.
Parameters:
Parameter | Type | Description |
---|---|---|
| string | Optional label of the user's virtual account. |
| string | Optional UUID of the user's virtual account. |
Response:
Error Handling:
Error Code | Description |
---|---|
| Unauthorized access, possibly due to bad token. |
Example Code:
GET /transfer/history/received
- Received Transfer History
/transfer/history/received
- Received Transfer HistoryDescription: Retrieves the history of all transfers received into the user's virtual accounts.
Parameters:
Parameter | Type | Description |
---|---|---|
| string | Optional label of the user's virtual account. |
| string | Optional UUID of the user's virtual account. |
Response:
Error Handling:
Error Code | Description |
---|---|
| Unauthorized access, possibly due to bad token. |
Example Code:
GET /virtual/virtual-transfer-fee/total
- Retrieve Total Virtual Transfer Fees
/virtual/virtual-transfer-fee/total
- Retrieve Total Virtual Transfer FeesDescription: This endpoint retrieves the total of virtual transfer fees for a specific user from the specified address.
Parameters:
Parameter | Type | Description | Required |
---|---|---|---|
| string | Blockchain address to filter the transactions. | Yes |
Response:
Error Handling:
Error Code | Description |
---|---|
| Provided 'from' parameter is invalid. |
Example Code:
GET /virtual/virtual-transfer-fee/history
- Retrieve Virtual Transfer Fee History
/virtual/virtual-transfer-fee/history
- Retrieve Virtual Transfer Fee HistoryDescription: This endpoint retrieves the history of virtual transfer fees for a specific user from the specified address with pagination.
Parameters:
Parameter | Type | Description | Required |
---|---|---|---|
| string | Blockchain address to filter the transactions. | No |
| integer | Page number for pagination. | No |
Response:
Error Handling:
Error Code | Description |
---|---|
| Provided 'from' parameter is invalid. |
Example Code:
Last updated