Withdraw

Withdraw funds from user account

post

Withdraws funds from the user's account to the specified address.

Header parameters

x-api-keystringrequired

API key for authentication.

Example: your-api-key

Body

protocolstring

The protocol for the withdrawal.

Example: bitcoin

tokenstring

The token for the withdrawal.

Example: BTC

amountnumber

The amount to withdraw.

Example: 0.5

addressstring

The address to withdraw to.

Example: bc1qh3rp2pns6nrr8mhx0rlzd5kktwm33wc4ax0h4y

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.ordinalsbot.com/tokenpay/user/account/withdraw' \
  --header 'x-api-key: your-api-key' \
  --header 'Content-Type: application/json' \
  --data '{
    "protocol": "bitcoin",
    "token": "BTC",
    "amount": 0.5,
    "address": "bc1qh3rp2pns6nrr8mhx0rlzd5kktwm33wc4ax0h4y"
  }'

200

400

500

200

{
  "id": "f2bcddd4-bd8d-4c88-bf8a-61be0d5b0600",
  "accountId": "user123",
  "protocol": "bitcoin",
  "token": "BTC",
  "amount": 0.5,
  "address": "bc1qh3rp2pns6nrr8mhx0rlzd5kktwm33wc4ax0h4y",
  "state": "pending",
  "createdAt": 1721745751531
}

Successfully created the withdrawal request.