WEBHOOKcallback_url
Order Payment Notification
Connect the URL under Settings → Notifications, or pass callback_url on create. We POST when order status changes. Return HTTP 2xx and a body strictly equal to success (trimmed, case-insensitive). See the Webhooks guide to connect, test, and verify.
Headers and body
X-Bytix-EventheaderrequiredSame as event in the JSON body.
X-Bytix-SignatureheaderrequiredHex HMAC-SHA256 of the raw JSON body with your webhook secret.
Content-Typeheaderrequiredapplication/json
eventstringrequiredorder.paid, order.paid_partial, order.paid_over, order.review, order.expired, order.cancelled. One delivery per status change, not per transfer.
event_typestringrequiredSuffix after order. (paid, paid_partial, paid_over, review, expired, cancelled).
cidstringrequiredPublic payment id from create. Fulfill once per paid cid.
order_idstringrequiredYour order id from create.
payer_idstringoptionalYour user id, if sent on create.
order_amountstringoptionalFiat amount as a decimal string.
order_currencystringoptionalFiat currency.
statusstringrequiredCurrent order status after the change.
crypto_amountstringoptionalQuoted crypto amount, or null if no quote yet (typical for expired from pending).
source_deductionstringoptionalQuote minus applied crypto when funds have been applied. Informational.
asset_symbolstringoptionalQuoted ticker, or null.
network_namestringoptionalQuoted network, or null.
payment_addressstringoptionalAddress after quote lock, or null.
txidstringoptionalOn-chain transaction id when a transfer matched.
received_amountstringoptionalAmount of the matched transfer for this event, not the lifetime total.
demobooleanrequiredTrue for an order created with a demo key. Simulated: never credit a customer for it.