Hercle
REST
POST/api/v1/withdrawals/address

Create 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

NameTypeRequiredDescription
AuthorizationstringYesBearer token for authentication
Content-TypestringYesContent type of the request body
Client-IdstringNo⚠️ 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 withdraw
amount*:number
// Amount to withdraw
address*:string
// Destination address for the withdrawal
addressParams*:object
// Additional parameters for the destination address
network*:string
// Network to use for the withdrawal
isInstant*:boolean
// Flag to indicate if the withdrawal should be instant

Example

{
  "asset": "GBP",
  "amount": 1000,
  "address": "GB33BUKB20201555555555",
  "addressParams": {
    "sortcode": "20-20-15",
    "accountNumber": "55555555"
  },
  "network": "Bitcoin"
}

Response

Success Response Schema

FieldTypeDescription
idstringUnique identifier for the withdrawal
userIdstringUser identifier who initiated the withdrawal
clientIdstringClient identifier associated with the withdrawal
namestringFirst name of the user
surnamestringLast name of the user
companystringCompany name if applicable
descriptionstringDescription or note for the withdrawal
destinationstringDestination address for the withdrawal
destinationParamsobjectAdditional destination parameters
networkstringNetwork name (e.g., Bitcoin, Ethereum)
amountnumberWithdrawal amount
feenumberFee charged for the withdrawal
assetstringAsset code (e.g., BTC, ETH, USD)
statusstring
Current status of the withdrawal
Allowed values:
CREATED
CONFIRMING
CONFIRMED
refIdstringReference ID for the withdrawal
isInstantbooleanWhether this is an instant withdrawal
timestampstringISO 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