BxBytix

WEBHOOKcallback_url

Order Payment Notification

We POST when order status changes. Your server must return HTTP 2xx and a body strictly equal to success (trimmed, case-insensitive).

Headers and body

X-Bytix-Eventheaderrequired

Same as event in the JSON body.

X-Bytix-Signatureheaderrequired

Hex HMAC-SHA256 of the raw JSON body with your webhook secret.

Content-Typeheaderrequired

application/json

eventstringrequired

order.paid, order.paid_partial, order.paid_over, order.expired, order.cancelled. One delivery per status change, not per transfer.

event_typestringrequired

Suffix after order. (paid, paid_partial, paid_over, expired, cancelled).

cidstringrequired

Public payment id from create. Fulfill once per paid cid.

order_idstringrequired

Your order id from create.

payer_idstringoptional

Your user id, if sent on create.

order_amountstringoptional

Fiat amount as a decimal string.

order_currencystringoptional

Fiat currency.

statusstringrequired

Current order status after the change.

crypto_amountstringoptional

Quoted crypto amount, or null if no quote yet (typical for expired from pending).

asset_symbolstringoptional

Quoted ticker, or null.

network_namestringoptional

Quoted network, or null.

payment_addressstringoptional

Address after quote lock, or null.

txidstringoptional

On-chain transaction id when a transfer matched.

received_amountstringoptional

Amount of the matched transfer for this event, not the lifetime total.

PreviousList AssetsNext Payout notification