Create withdrawalPOST

OpenStock Docs

POST

/api/withdrawal-api/withdrawals

withdrawal_api50 withdrawal requests / hour

Requests a withdrawal from one of the store’s wallets. The request is accepted as pending and processed in the background; subscribe with webhook_url to learn the outcome.

Irreversible

Crypto transfers cannot be reversed. Validate destination addresses on your side before calling this endpoint.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the withdrawal_api permission.

Request body#

application/json

currencyrequiredstring

BTC, LTC or ETH.

amountrequirednumber

Amount to withdraw. Minimums: BTC 0.0001, LTC 0.001, ETH 0.001.

to_addressrequiredstring

Destination address. Must be valid for the currency and differ from the store wallet.

webhook_urlstring

Receives withdrawal.completed or withdrawal.failed.

metadataobject

Key/value pairs echoed back in webhooks.

Responses#

201Withdrawal accepted for processing.
400Invalid currency, amount below minimum, bad address or insufficient balance.
404The store has no active wallet for that currency.
401Missing, malformed, disabled or expired API key.
429The hourly limit for this key was reached.

curl -X POST "https://openstock.dev/api/withdrawal-api/withdrawals" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "LTC",
    "amount": 0.05,
    "to_address": "ltc1qexampleaddressxxxxxxxxxxxxxxxxxxxxxx",
    "webhook_url": "https://example.com/webhooks/withdrawals"
  }'

Withdrawal accepted for processing.

{
  "id": "wd_4b8e2f0c9a1d",
  "status": "pending",
  "amount": 0.05,
  "fee_amount": 0.002,
  "net_amount": 0.048,
  "currency": "LTC",
  "to_address": "ltc1qexampleaddressxxxxxxxxxxxxxxxxxxxxxx",
  "created_at": "2026-03-04T18:30:00.000Z"
}