WEBHOOKcallback_url
Payout Notification
Sent to the payout's callback_url, else the payout webhook URL, else the webhook URL from Settings → Notifications, signed with the same webhook secret. We POST when a withdrawal status changes. The body is the payout object plus event, without quote_rate and created_at. Return HTTP 2xx and a body strictly equal to success.
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.
eventstringrequiredpayout.awaiting_approval, payout.pending, payout.rejected, payout.submitted, payout.completed, or payout.failed: always payout. plus the payout status.
payout_idstringrequiredYour payout id from create.
idstringrequiredBytix payout id.
amountstringrequiredUSD amount as a decimal string.
currencystringrequiredUSD.
assetstringoptionalTicker sent on-chain.
networkstringoptionalNetwork display name.
addressstringrequiredDestination address.
crypto_amountstringoptionalQuoted crypto for the requested USD.
fee_amountstringoptionalFees of the withdrawal, in the payout asset.
fee_paid_bystringoptionalmerchant or customer. With customer the fees are taken off what is sent.
net_amountstringoptionalCrypto sent on-chain.
statusstringrequiredCurrent payout status after the change.
txidstringoptionalOn-chain transaction id when completed.
payer_idstringrequiredYour user id from create.
demobooleanrequiredTrue for a payout created with a demo key. Simulated: never debit a customer for it.