Payout

To test the API, make sure to include x-api-key in the header with your API key.

Create payout.

post

Creates a payout by specifying the wallet address, amount, currency, network, customer details, and an optional webhook URL for notifications. This endpoint initiates the process of transferring funds to the user's specified wallet.

Authorizations
Body

Withdrawal creation request body.

methodstring · enumOptional

A method to make a payout (e.g., to a web3 wallet, or Binance Account).

Default: directPossible values:
binanceIdstring · min: 1Optional

Recipient's Binance Pay ID. If the payout method is Binance Pay, this field is required.

walletAddressstringOptional

Recipient's wallet address.

networkFeeByUserbooleanRequired

Specifies whether the network fee should be deducted from the amount being withdrawn (true) or the remaining balance (false). Choose the latter option if you need to send a specific amount.

amountnumberRequired

Amount to withdraw.

currencystring · min: 1Required

Currency for withdrawal, specified via tickers (refer to API glossary).

networkstring · min: 1Required

Blockchain network for withdrawal, specified via tickers (refer to API glossary).

customerIdstring · min: 1Required

Customer's ID for security purposes.

customerIpstring · min: 1Required

Customer's IP address for security purposes.

orderIdstring · min: 1Required

Customer's order ID.

additionalDatastringOptional

Additional information related to the payout, if needed.

webhookUrlstringOptional

Webhook address for receiving withdrawal notifications.

Responses
201
201
application/json
post
POST /v1/payout HTTP/1.1
Host: api.bitnbox.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "method": "direct",
  "binanceId": "text",
  "walletAddress": "text",
  "networkFeeByUser": true,
  "amount": 1,
  "currency": "text",
  "network": "text",
  "customerId": "text",
  "customerIp": "text",
  "orderId": "text",
  "additionalData": "text",
  "webhookUrl": "text"
}
{
  "payoutId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "created",
  "amount": 1,
  "walletAddress": "text",
  "binanceId": "text",
  "networkFeeByUser": true,
  "currency": "text",
  "network": "text",
  "customerId": "text",
  "customerIp": "text",
  "orderId": "text",
  "additionalData": "text",
  "webhookUrl": "https://example.com",
  "createdAt": "2025-07-03T01:06:54.820Z",
  "updatedAt": "2025-07-03T01:06:54.820Z"
}
get
Authorizations
Path parameters
idstring · uuidRequired

Unique identifier of the withdrawal

Responses
200
200
application/json
get
GET /v1/payout/{id}/status HTTP/1.1
Host: api.bitnbox.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "payoutId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "created",
  "amount": 1,
  "walletAddress": "text",
  "binanceId": "text",
  "networkFeeByUser": true,
  "currency": "text",
  "network": "text",
  "customerId": "text",
  "customerIp": "text",
  "orderId": "text",
  "additionalData": "text",
  "webhookUrl": "https://example.com",
  "createdAt": "2025-07-03T01:06:54.820Z",
  "updatedAt": "2025-07-03T01:06:54.820Z",
  "paidAmount": 1,
  "merchantAmount": 1
}

Estimate withdrawal fee.

get

Estimates the withdrawal fee for a given currency and network.

Authorizations
Query parameters
currencystringRequired

Currency for which the withdrawal fee is to be estimated.

networkstringRequired

Blockchain network for which the withdrawal fee is to be estimated.

Responses
200
200
application/json
get
GET /v1/payout/estimate-fee HTTP/1.1
Host: api.bitnbox.io
x-api-key: YOUR_API_KEY
Accept: */*
200

200

{
  "currency": "text",
  "network": "text",
  "amount": 1,
  "amountUsd": 1
}
PreviousPaymentNextChangelog

Last updated