Skip to main content
POST
/
v1
/
payout
Create payout
curl --request POST \
  --url https://api.bitnbox.io/v1/payout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "walletAddress": "<string>",
  "networkFeeByUser": true,
  "amount": 123,
  "currency": "<string>",
  "network": "<string>",
  "customerId": "<string>",
  "customerIp": "<string>",
  "orderId": "<string>",
  "additionalData": "<string>",
  "webhookUrl": "<string>"
}
'
{
  "payoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "amount": 123,
  "walletAddress": "<string>",
  "networkFeeByUser": true,
  "currency": "<string>",
  "network": "<string>",
  "customerId": "<string>",
  "customerIp": "<string>",
  "orderId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "additionalData": "<string>",
  "webhookUrl": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Body

Withdrawal creation request body

​
walletAddress
string
required

User's wallet address

​
networkFeeByUser
boolean
required
​
amount
number
required

Amount to withdraw

​
currency
string
required

Currency for withdrawal

​
network
string
required

Blockchain network for withdrawal

​
customerId
string
required

Customer ID (for security)

Minimum string length: 1
​
customerIp
string
required

Customer IP address (for security)

Minimum string length: 1
​
orderId
string
required

Customer order ID

Minimum string length: 1
​
additionalData
string

Additional data for the withdrawal

​
webhookUrl
string

Webhook address

Response

200

Successful withdrawal creation response

​
payoutId
string<uuid>
required

Payout ID

​
status
enum<string>
required

Payout status

Available options:
created,
review,
processing,
confirming,
paid,
failed,
cancelled
​
amount
number
required

The requested amount for payout

​
walletAddress
string
required

The address to which payout was made

​
networkFeeByUser
boolean
required

Who paid the blockchain fee, merchant or end user

​
currency
string
required

The currency key: usdt, eth, usdc, etc

​
network
string
required

The network key: eth, sepolia, tron, etc

​
customerId
string
required

The end user ID, set by the merchant

​
customerIp
string
required

The IP address of the end user, set by the merchant

​
orderId
string
required

The order ID for the withdrawal, set by the merchant

​
createdAt
string<date-time>
required

Date of creation

​
updatedAt
string<date-time>
required

Date of update

​
additionalData
string

Additional information, optional, set by the merchant

​
webhookUrl
string<uri>

The URL to which events for this withdrawal request will be sent