HTTP API
Reference
Base URL https://api.bytix.ai·Authorization: Bearer pk_...
Conventions
| Rule | Detail |
|---|---|
Auth | Bearer pk_ on every /v1 call. Portal cookies cannot call the API. |
Amounts | Decimal strings. Do not send JSON numbers. |
Create | HTTP 201 on a new order_id, payout_id or payout wallet, 200 if it already exists. |
Query | POST /v1/orders/info or POST /v1/payouts/info. |
Webhooks | Save the URL under Settings → Notifications, rotate the secret, then Send test. HMAC of the raw body. Reply with the plain text success. |
Withdrawals | Register the customer wallet (POST /v1/payout-wallets) and wait for approval before POST /v1/payouts. |
Error codes: 40000, 40001, 40002, 40003, 40100, 40400, 40900, 50300. Statuses: orders and payouts.
Orders
Create OrderCreate a payment order from your CRM. On success the API returns cid and checkout_url. The same order_id for a workspace returns the existing order (idempotent create).POST/v1/ordersQuery OrderLook up an order by cid or order_id. If both are sent, cid wins. Open orders past expiry are marked expired on this read and emit order.expired.POST/v1/orders/info
Payouts
Create PayoutCreate a customer withdrawal to an approved payout wallet. The amount is held from your main wallet balance of that asset on that network. New payouts start as awaiting_approval until the merchant approves in the dashboard (or automatically, under your auto-approve limit). Same payout_id for a workspace returns the stored payout (idempotent create). There is no checkout URL.POST/v1/payoutsQuery PayoutLook up a payout by payout_id or id. If both are sent, id wins.POST/v1/payouts/infoCreate Payout WalletRegister a customer's withdrawal address. Payouts can only go to a wallet the merchant has approved for that payer_id, asset and network. New wallets are pending until the merchant approves or rejects them in the dashboard under Withdrawals → Customer wallets. Submitting the same wallet again returns it (idempotent).POST/v1/payout-walletsList Payout WalletsList the customer payout wallets you registered, newest first, with their approval status.GET/v1/payout-walletsBalanceYour balance per asset and network, plus totals in USD. Paid orders wait as collectible until you collect them into your main wallet; payouts are sent from what is available there.GET/v1/balance
Assets
Webhooks
Order Payment NotificationConnect 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.WEBHOOKcallback_urlPayout NotificationSent 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.WEBHOOKcallback_url