List Withdrawals

GET

/withdrawal/

Retrieves a paginated list of withdrawals associated with the authenticated merchant. Results can be filtered by various criteria.

Authentication

Requires OAuth 2.0 authentication with read and write scopes.

Query Parameters

Parameter	Type	Required	Description
status	string	No	Filter by withdrawal status
blockchain	string	No	Filter by blockchain network (e.g., ETH, TRX)
token	string	No	Filter by token (e.g., USDT)
start_date	string	No	ISO 8601 date to filter withdrawals created on or after this date
end_date	string	No	ISO 8601 date to filter withdrawals created on or before this date
custom_id	string	No	Filter by your custom withdrawal identifier
limit	integer	No	Maximum number of withdrawals to return per page (default: 20, max: 100)
offset	integer	No	Number of withdrawals to skip (for pagination)
sort	string	No	Sort order for results (e.g., created_asc, created_desc)

Example Request

curl -X GET "{{BASE_URL}}/withdrawal/?limit=10&status=completed&blockchain=ETH&start_date=2025-01-01T00:00:00Z" \
  -H "Authorization: Bearer your_access_token"

Response

Success Response (200 OK)

{
  "withdrawals": [
    {
      "withdrawal_id": "550e8400-e29b-41d4-a716-446655440000",
      "custom_id": "WITHDRAW-123",
      "amount": "100.50000000",
      "fee": "1.50000000",
      "platform_fee": "1.00000000",
      "network_fee": "0.50000000",
      "blockchain": "ETH",
      "token": "USDT",
      "currency": "USDTERC20",
      "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "status": "completed",
      "transaction_hash": "0xab5d35434fe46ef9c5d215238a3dbb42d2f3c84e7a36f80c61244ea9ac81ef73",
      "created_at": "2025-04-10T15:30:00Z",
      "updated_at": "2025-04-10T16:45:12Z"
    }
  ],
  "total": 15
}

Response Fields

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

Error Responses

401 Unauthorized

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication failed or token is missing",
    "details": {}
  }
}

Notes

• Results are paginated with the default limit of 20 withdrawals per page
• Use the offset parameter along with limit for pagination
• The transaction_hash is only available for withdrawals that have been submitted to the blockchain
• Date filters use the created_at timestamp for filtering