Get Withdrawals by ClientId

Retrieve a paginated list of withdrawals filtered by clientId.

Auth:Bearer <api_key>

Tags:Withdrawals

Request

cURL

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

Path Parameters

Name	Type	Required	Description
withdrawClientId	string	Yes	Client ID for filtering withdrawals. Example: `client_001`

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

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

Path Parameters

withdrawClientId

Required

Client ID for filtering withdrawals.

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/withdrawals/{withdrawClientId}