List Withdrawals
Fetch withdrawals.
GET /v1/account/withdrawals
Headers:
Param | Type |
---|---|
apikey | string |
Query Parameters:
Param | Type | Mandatory | Description |
---|---|---|---|
withdrawalId | integer | No | Unique withdrawal identifier |
currency | string | No | Currency |
limit | integer | No | Number of results per request. Minimum is 1 , maximum is 100 , default is 100 . |
offset | integer | No | The number of elements to skip |
info
If withdrawalId
and currency
has provided in the same request, the withdrawalId
will take precedence in the request.
Response:
Param | Type | Description |
---|---|---|
withdrawalId | integer | Unique withdrawal identifier |
amount | decimal | Withdrawal amount |
transactionFee | decimal | Withdrawal fee |
confirmations | integer | Number of confirmations to make an transaction on chain |
txId | string | The blockchain hash of the transaction |
currency | string | Currency |
address | string | Withdrawal address |
chain | string | The blockchain of the currency |
status | string | Status. available values: PROGRESS , DONE , OPEN , CANCELED and ERROR . |
info | string | Information when something goes wrong |
createdAt | timestamp | created at (milisecond) |
updatedAt | timestamp | last updated (milisecond) |
Limit | integer | Number of results per requested |
Offset | integer | The number of elements skiped |
totalPage | integer | Total number of pages |
TotalItem | integer | Total items returned from the request |
Response Example
{
"success": true,
"data": {
"items": [
{
"withdrawalId": 65987,
"amount": 99999,
"transactionFee": 0.0005,
"confirmations": 0,
"txId": "624d5e2d436e8f48d1399898fd421ef18f115d9f8951bc2c4776981d29839c6c",
"currency": "KLV",
"address": "klv1lwv996lr5vq8p6r2gmwyxtj7567fc089y9q3dwu24l8l4g5k8husl8psu4",
"chain": "KLV",
"status": "OPEN",
"info": "",
"createdAt": 1671568671,
"updatedAt": 1671568671
},
{
"withdrawalId": 65988,
"amount": 10000.9996,
"transactionFee": 100.0005,
"confirmations": 6,
"txId": "624d5e2d436e8f48d1399898fd421ef18f115d9f8951bc2c4776981d29839c6c",
"currency": "KLV",
"address": "klv1lwv996lr5vq8p6r2gmwyxtj7567fc089y9q3dwu24l8l4g5k8husl8psu4",
"chain": "KLV",
"status": "OPEN",
"info": "",
"createdAt": 1671568425,
"updatedAt": 1671568425
}
],
"totalPage": 1,
"offset": 2,
"limit": 100,
"totalItem": 2
}
}