Payment

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

Create payment

post

Creates a payment link. You need to provide the amount and the currency of the payment in the request.

Authorizations

Body

Payment creation request body

methodstring · enumOptional

A method to receive a payment (on-chain or via Binance Pay).

Default: directPossible values:

amountnumberRequired

The amount you want to receive from your customer.

processingFeeByUserbooleanRequired

If true, the initial amount will be increased to cover the platform fee.

currencystring · min: 1Required

Specifies the cryptocurrency for the payment via tickers (refer to API glossary).

networkstring · min: 1Required

Specifies the blockchain network for the payment via tickers (refer to API glossary).

customerIdstring · min: 1Required

Customer's ID for security purposes.

customerIpstring · min: 1Required

The customer's IP address, recorded for compliance purposes.

orderIdstring · min: 1Required

orderDescriptionstring · min: 1Required

Order description

additionalDatastringOptional

Additional information related to the payment, if needed.

webhookUrlstringOptional

An optional URL where transaction status updates and payment notifications will be sent.

Responses

201

201

application/json

500

500

application/json

post

HTTPcURLJavaScriptPython

POST /v1/payment HTTP/1.1
Host: api.bitnbox.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "method": "direct",
  "amount": 1,
  "processingFeeByUser": true,
  "currency": "text",
  "network": "text",
  "customerId": "text",
  "customerIp": "text",
  "orderId": "text",
  "orderDescription": "text",
  "additionalData": "text",
  "webhookUrl": "text",
  "products": [
    {
      "id": "text",
      "type": "01",
      "name": "text",
      "description": "text"
    }
  ]
}

{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "method": "direct",
  "status": "waiting",
  "payAmount": 1,
  "payAddress": "text",
  "payQrCodeUri": "text",
  "payCheckoutUrl": "text",
  "currency": "text",
  "network": "text",
  "customerId": "text",
  "customerIp": "text",
  "orderId": "text",
  "additionalData": "text",
  "processingFeeByUser": true,
  "createdAt": "2025-05-19T07:23:55.521Z",
  "updatedAt": "2025-05-19T07:23:55.521Z",
  "expiredAt": "2025-05-19T07:23:55.521Z",
  "webhookUrl": "https://example.com",
  "description": "text"
}

Get payment status by id

get

Get the actual information about the payment. You need to provide the ID of the payment in the request.

Authorizations

Path parameters

idstringRequired

Unique identifier of the payment

Responses

200

200

application/json

get

HTTPcURLJavaScriptPython

GET /v1/payment/{id}/status HTTP/1.1
Host: api.bitnbox.io
x-api-key: YOUR_API_KEY
Accept: */*

200

200

{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "method": "direct",
  "status": "waiting",
  "payAmount": 1,
  "payAddress": "text",
  "payQrCodeUri": "text",
  "payCheckoutUrl": "text",
  "currency": "text",
  "network": "text",
  "customerId": "text",
  "customerIp": "text",
  "orderId": "text",
  "additionalData": "text",
  "processingFeeByUser": true,
  "createdAt": "2025-05-19T07:23:55.521Z",
  "updatedAt": "2025-05-19T07:23:55.521Z",
  "expiredAt": "2025-05-19T07:23:55.521Z",
  "webhookUrl": "https://example.com",
  "description": "text",
  "paidAmount": 1,
  "merchantAmount": 1,
  "paidAddress": "text"
}