List Withdrawals

GET

/withdrawal/

Retrieves a paginated list of withdrawals associated with the authenticated user or API key. Results can be filtered by various criteria.

Request Headers

Header	Description
Authorization required	Bearer token for authentication: `Bearer <access_token>`
X-API-Key optional	API key for authentication (alternative to OAuth 2.0 access token)

Query Parameters

Parameter	Type	Description
limit optional	integer	Maximum number of withdrawals to return per page (default: 20, max: 100)
offset optional	integer	Number of withdrawals to skip (for pagination)
status optional	string	Filter by withdrawal status. Options: `pending`, `approved`, `processing`, `submitted`, `confirmed`, `completed`, `rejected`, `failed`, `cancelled`
blockchain optional	string	Filter by blockchain network. Options: `ETH`, `BSC`, `TRX`, `SOL`
token optional	string	Filter by token (e.g., `USDT`)
start_date optional	string	ISO 8601 date to filter withdrawals created on or after this date
end_date optional	string	ISO 8601 date to filter withdrawals created on or before this date
custom_id optional	string	Filter by your custom withdrawal identifier
sort optional	string	Sort order for results. Options: `created_asc`, `created_desc` (default), `amount_asc`, `amount_desc`

Example Request

GET /withdrawal/?limit=10&status=completed&blockchain=ETH&start_date=2025-01-01T00:00:00Z
Authorization: Bearer d1UUviKpHizUGsGZuboebXS6YgwcAl

Response Parameters

Parameter	Type	Description
withdrawals	array	Array of withdrawal objects
withdrawals[].withdrawal_id	string	Unique identifier for the withdrawal
withdrawals[].status	string	Current status of the withdrawal
withdrawals[].amount	number	Withdrawal amount
withdrawals[].fee	number	Fee charged for the withdrawal
withdrawals[].address	string	Destination wallet address
withdrawals[].blockchain	string	Blockchain network used
withdrawals[].token	string	Token being withdrawn
withdrawals[].created_at	string	ISO 8601 timestamp of withdrawal creation
withdrawals[].updated_at	string	ISO 8601 timestamp of last status update
withdrawals[].custom_id	string	Your custom identifier for this withdrawal, if provided
withdrawals[].transaction_hash	string	Blockchain transaction hash, if available
total	integer	Total number of withdrawals matching the filters

Example Response

{
  "withdrawals": [
    {
      "withdrawal_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "completed",
      "amount": 100.50,
      "fee": 1.50,
      "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "blockchain": "ETH",
      "token": "USDT",
      "created_at": "2025-04-10T15:30:00Z",
      "updated_at": "2025-04-10T16:45:12Z",
      "custom_id": "WITHDRAWAL-123",
      "transaction_hash": "0xab5d35434fe46ef9c5d215238a3dbb42d2f3c84e7a36f80c61244ea9ac81ef73"
    },
    {
      "withdrawal_id": "c82f8900-a29c-41e4-b617-438655440122",
      "status": "completed",
      "amount": 250.00,
      "fee": 2.75,
      "address": "0x891a35Dd6634C0987925a3b123Bc454e4438abc1",
      "blockchain": "ETH",
      "token": "USDT",
      "created_at": "2025-03-15T10:12:00Z",
      "updated_at": "2025-03-15T11:35:20Z",
      "custom_id": "WITHDRAWAL-456",
      "transaction_hash": "0xcd8e21cfe46ef9c5d347638a3dbb42d2f3c84e7a36f80c61244ea9ac81ef012"
    }
  ],
  "total": 15
}

Error Codes

Status Code	Error Code	Description
400	invalid_request	Invalid parameters or malformed request
401	unauthorized	Authentication failed or token is missing
403	forbidden	Insufficient permissions to list withdrawals
429	rate_limit_exceeded	Too many requests in a short period

Notes

Results are paginated with the default limit of 20 withdrawals per page
Use the offset parameter along with the limit parameter for pagination
For most efficient queries, use combination of filters
The transaction_hash is only available for withdrawals that have been submitted to the blockchain
Use the sort parameter to control the order of results
Date filters use the created_at timestamp for filtering

Example: Filtering by Date Range

To retrieve all completed withdrawals from January 2025:

GET /withdrawal/?status=completed&start_date=2025-01-01T00:00:00Z&end_date=2025-01-31T23:59:59Z
Authorization: Bearer d1UUviKpHizUGsGZuboebXS6YgwcAl

Example: Searching by Custom ID

To find a specific withdrawal using your custom identifier:

GET /withdrawal/?custom_id=WITHDRAWAL-123
Authorization: Bearer d1UUviKpHizUGsGZuboebXS6YgwcAl