Skip to content

POST /payment/white-label

Creates a white-label payment that returns a crypto address directly, without redirecting to a hosted page. Requires authentication.

POST /payment/white-label
FieldTypeRequiredDescription
pay_currencystringYesCryptocurrency to receive
amountnumberYesPayment amount
currencystringNoPrice currency (defaults to pay_currency)
networkstringNoBlockchain network
lifetimenumberNoPayment lifetime in minutes
fee_paid_by_payer0 | 1NoWhether the payer covers network fees
under_paid_coveragenumberNoPercentage tolerance for underpayment
to_currencystringNoAuto-convert received funds to this currency
callback_urlstringNoWebhook URL for payment updates
emailstringNoCustomer email
order_idstringNoYour internal order ID
descriptionstringNoPayment description
Terminal window
curl -X POST https://api.nearpayments.io/oxapay/v1/payment/white-label \
-H "merchant_api_key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pay_currency": "BTC",
"amount": 0.001,
"order_id": "wl-200",
"callback_url": "https://example.com/webhook"
}'
{
"data": {
"track_id": "def456",
"amount": 0.001,
"currency": "BTC",
"pay_amount": 0.001,
"pay_currency": "BTC",
"network": "BTC",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"callback_url": "https://example.com/webhook",
"description": null,
"email": null,
"fee_paid_by_payer": 0,
"lifetime": 60,
"order_id": "wl-200",
"under_paid_coverage": 0,
"rate": 60000,
"qr_code": "https://oxapay.com/qr/def456",
"expired_at": 1700000000,
"date": 1699996400
},
"message": "Operation completed successfully!",
"error": {},
"status": 200,
"version": "1.0.0"
}