REST
POST
/api/v1/withdrawals/addressCreate Withdrawal With Address Params
Submit a new withdrawal request with address parameters.
Auth:Bearer <api_key>
Tags:WithdrawalsIdempotent
Request
cURL
curl -X POST https://publicapi.sandbox.hercle.financial/api/v1/withdrawals/address \
-H "Authorization: Bearer eyJhb..." \
-H "Content-Type: application/json" \
-d '{"key": "value"}'Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication |
| Content-Type | string | Yes | Content type of the request body |
| Client-Id | string | No | ⚠️ Sandbox only. Unique idempotency key for the request. If a request with the same Client-Id is received within 6 hours, the original response is returned. |
Request Body
Schema
object
asset*:string
// Asset to withdrawamount*:number
// Amount to withdrawaddress*:string
// Destination address for the withdrawaladdressParams*:object
// Additional parameters for the destination addressnetwork*:string
// Network to use for the withdrawalisInstant*:boolean
// Flag to indicate if the withdrawal should be instantExample
{
"asset": "GBP",
"amount": 1000,
"address": "GB33BUKB20201555555555",
"addressParams": {
"sortcode": "20-20-15",
"accountNumber": "55555555"
},
"network": "Bitcoin"
}Response
Success Response Schema
Withdrawal created 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: CREATEDCONFIRMINGCONFIRMED |
refId | string | Reference ID for the withdrawal |
isInstant | boolean | Whether this is an instant withdrawal |
timestamp | string | ISO 8601 timestamp of withdrawal creation |
Responses
Withdrawal created successfully
201 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
Get your API key from Hercle Sandbox
https://publicapi.sandbox.hercle.financial/api/v1/withdrawals/address