Get Withdrawals

Returns an array of the user's historic withdrawals. Supports filtering and pagination.

Pagination parameters (page, pageSize) are only necessary when filtering by fields that can return multiple items (asset, network). When filtering by withdrawalId, pagination is not required as it returns at most one result.

Auth:Bearer <api_key>

Tags:Withdrawals

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/withdrawals \
  -H "Authorization: Bearer eyJhb..." \

Query Parameters

Name	Type	Required	Description
clientId	string	No	Filter by client ID Example: `123e4567-e89b-12d3-a456-426614174000`
withdrawalId	string	No	Filter by withdrawal ID (unique, returns at most one result) Example: `987e6543-e21b-12d3-a456-426614174999`
network	string	No	Filter by network name Example: `Ethereum`
asset	string	No	Filter by asset name Example: `ETH`
address	string	No	Filter by destination address Example: `0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb`
startDate	string	No	Start date for filtering (ISO 8601 format) Example: `2024-01-01T00:00:00Z`
endDate	string	No	End date for filtering (ISO 8601 format) Example: `2024-12-31T23:59:59Z`
page	number	No	Page number for pagination (only needed when filtering by asset/network) Example: `0`
pageSize	number	No	Number of items per page (only needed when filtering by asset/network) Example: `5`

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication
Content-Type	string	Yes	Content type of the request

Response

Success Response Schema

List of withdrawals retrieved successfully

Field	Type	Description
`id`	string	Unique identifier for the withdrawal
`userId`	string	User identifier who initiated the withdrawal
`clientId`	string	Client identifier associated with the withdrawal
`name`	string	First name of the user
`surname`	string	Last name of the user
`company`	string	Company name if applicable
`description`	string	Description or note for the withdrawal
`destination`	string	Destination address for the withdrawal
`destinationParams`	object	Additional destination parameters
`network`	string	Network name (e.g., Bitcoin, Ethereum)
`amount`	number	Withdrawal amount
`fee`	number	Fee charged for the withdrawal
`asset`	string	Asset code (e.g., BTC, ETH, USD)
`status`	string	Current status of the withdrawal Allowed values: `CREATED` `CONFIRMING` `CONFIRMED`
`refId`	string	Reference ID for the withdrawal
`isInstant`	boolean	Whether this is an instant withdrawal
`timestamp`	string	ISO 8601 timestamp of withdrawal creation

Responses

List of withdrawals retrieved successfully

200 application/json

[
  {
    "id": "987e6543-e21b-12d3-a456-426614174000",
    "userId": "987e6543-e21b-12d3-a456-426614174999",
    "clientId": "client_001",
    "name": "John",
    "surname": "Doe",
    "company": "Acme Corp",
    "description": "Withdrawal to personal wallet",
    "destination": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "destinationParams": {},
    "network": "Bitcoin",
    "amount": 0.01,
    "fee": 0.0005,
    "asset": "BTC",
    "status": "CREATED",
    "refId": "withdrawal_ref_001",
    "isInstant": false,
    "timestamp": "2024-06-01T12:00:00Z"
  }
]

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Query Parameters

clientId

Filter by client ID

withdrawalId

Filter by withdrawal ID (unique, returns at most one result)

network

Filter by network name

asset

Filter by asset name

address

Filter by destination address

startDate

Start date for filtering (ISO 8601 format)

endDate

End date for filtering (ISO 8601 format)

page

Page number for pagination (only needed when filtering by asset/network)

pageSize

Number of items per page (only needed when filtering by asset/network)

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/withdrawals