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

Authorizations

​
x-api-key
string
header
required

Body

application/json

Body

Payment creation request body

​
amount
number
required

Amount in cryptocurrency

Required range: x > 0
​
platformFeeByUser
boolean
required
​
currency
string
required

Cryptocurrency type (btc, usdt, eth, etc)

Minimum string length: 1
​
network
string
required

Cryptocurrency network

​
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

Order id

​
additionalData
string

Additional data

​
webhookUrl
string

Webhook address

Response

201

Payment link creation successful

​
paymentId
string<uuid>
required

Unique payment identifier

​
status
enum<string>
required

Payment status

Available options:
waiting,
confirming,
failed,
locked,
rejected,
expired,
paid,
paid_over,
paid_partial
​
payAmount
number
required

Crypto AMOUNT+PERCENT

​
payAddress
string
required

Payment address

​
payQrCodeUri
string
required

URI for payment QR code

​
currency
string
required

Cryptocurrency type (btc, usdt, eth, etc)

Minimum string length: 1
​
network
string
required

Cryptocurrency network (e.g., erc20)

​
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

Order id

​
platformFeeByUser
boolean
required

Fee by user/merchant

​
createdAt
string<date-time>
required

Date of creation

​
updatedAt
string<date-time>
required

Date of update

​
expiredAt
string<date-time>
required

Date of expire

​
webhookUrl
string<uri>
required

Webhook url

​
additionalData
string

Additional data