POST/v1/payouts
Create Payout
Create 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.
Request body
payout_idstringrequiredYour payout ID. Unique per workspace. Reuse returns the stored payout and does not debit again.
amountstringrequiredUSD amount as a decimal string, greater than 0.
assetstringrequiredTicker from GET /v1/coins payout_coins[].symbol, for example USDT.
networkstringrequiredNetwork from payout_coins[].network: Tron, Ethereum or Binance Smart Chain (case-insensitive). The protocol (TRC-20, ERC-20, BEP-20) is also accepted.
addressstringrequiredDestination address on that network. Must be an approved payout wallet of this payer_id for this asset and network (see Create Payout Wallet).
payer_idstringrequiredYour user id. Must own the approved payout wallet. Shown on the dashboard Withdrawals list.
callback_urlstringoptionalPer-payout webhook URL, http:// or https://. If omitted, payout events go to the payout webhook URL, else the webhook URL, from Settings → Notifications.
Headers
AuthorizationheaderrequiredBearer pk_… from dashboard Settings → Developer.
Content-Typeheaderoptionalapplication/json on POST bodies. Not required on GET.
Response data
Wrapped as { code, msg, data }. HTTP 201 on a new payout, 200 when payout_id already exists.
idstringrequiredBytix payout id. Stable. Use it with query if you stored it.
payout_idstringrequiredYour payout id. Unique per workspace. Repeating it on create returns this same payout.
amountstringrequiredUSD amount as a decimal string.
currencystringrequiredAlways USD.
assetstringrequiredTicker sent on-chain, for example USDT.
networkstringrequiredNetwork display name, for example Tron.
addressstringrequiredDestination address.
crypto_amountstringoptionalQuoted crypto amount for the requested USD, as a decimal string.
fee_amountstringoptionalFees of the withdrawal, in the payout asset.
fee_paid_bystringoptionalmerchant: the fees come from your balance and the full amount is sent. customer: they are taken off what is sent.
net_amountstringoptionalCrypto sent on-chain: crypto_amount when you pay the fees, crypto_amount minus fee_amount when the customer does.
quote_ratestringoptionalUSD per unit of the asset at the market price when the withdrawal was requested.
statusstringrequiredawaiting_approval, pending (approved, being sent), submitted, completed, rejected, or failed.
txidstringoptionalOn-chain transaction id when completed, else null.
payer_idstringrequiredYour user id from create.
demobooleanrequiredTrue when the payout was created with a demo key. Simulated: nothing is sent and no balance changes.
created_atstringrequiredISO-8601 create time.
Errors
Failures still return JSON. Read code, not only the HTTP status. Full table: Errors.
40000HTTP 400optionalValidation: missing fields, amount ≤ 0, unknown asset/network, invalid address, or the destination is not an approved payout wallet of this payer_id.
40001HTTP 409optionalNot enough of that asset on that network in your main wallet. The message includes the available amount.
40003HTTP 400optionalAbove the maximum withdrawal, or the daily withdrawal limit, set for your account.
40100HTTP 401optionalMissing or invalid API key, or the workspace is not active.
50300HTTP 503optionalYour wallets are still being prepared, or the market price of that asset is briefly unavailable. Try again in a few minutes.