BxBytix

POST/v1/payouts

Create Payout

Send a customer withdrawal from available USD. Same payout_id for a workspace returns the stored payout (idempotent create). There is no checkout URL.

Request body

payout_idstringrequired

Your payout ID. Unique per workspace. Reuse returns the stored payout and does not debit again.

amountstringrequired

USD amount as a decimal string, greater than 0.

assetstringrequired

Ticker from GET /v1/coins payout_coins[].symbol, for example USDT.

networkstringrequired

Network display name from payout_coins[].network, for example Tron.

addressstringrequired

Destination address on that network.

payer_idstringoptional

Your user id. Shown on the dashboard Withdrawals list.

callback_urlstringoptional

Per-payout webhook URL. Defaults to Settings → Notifications.

Headers

Authorizationheaderrequired

Bearer pk_… from dashboard Settings → Developer.

Content-Typeheaderoptional

application/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.

idstringrequired

Bytix payout id. Stable. Use it with query if you stored it.

payout_idstringrequired

Your payout id. Unique per workspace. Repeating it on create returns this same payout.

amountstringrequired

USD amount as a decimal string.

currencystringrequired

Always USD.

assetstringrequired

Ticker sent on-chain, for example USDT.

networkstringrequired

Network display name, for example Tron.

addressstringrequired

Destination address.

crypto_amountstringoptional

Quoted crypto amount as a decimal string.

quote_ratestringoptional

USD per unit of asset used for the quote.

statusstringrequired

pending, submitted, completed, or failed.

txidstringoptional

On-chain transaction id when completed, else null.

payer_idstringoptional

Your user id, if sent on create.

created_atstringrequired

ISO-8601 create time.

Errors

Failures still return JSON. Read code, not only the HTTP status. Full table: Errors.

40000HTTP 400optional

Validation: missing fields, amount ≤ 0, unknown asset/network, invalid address, or insufficient available balance.

40100HTTP 401optional

Missing or invalid API key, or the workspace is not active.

PreviousQuery OrderNext Query Payout