BxBytix

POST/v1/payout-wallets

Create Payout Wallet

Register 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).

Request body

payer_idstringrequired

Your user id. Only this payer can withdraw to the wallet.

addressstringrequired

Destination address on that network. Checked immediately; an invalid address is refused.

assetstringrequired

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

networkstringrequired

Network from payout_coins[].network: Tron, Ethereum or Binance Smart Chain (case-insensitive). The protocol (TRC-20, ERC-20, BEP-20) is also accepted.

labelstringoptional

Optional name for the wallet, shown to the merchant.

payer_namestringoptional

Optional customer name, shown to the merchant.

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 for a new wallet, and for a rejected wallet submitted again (it goes back to pending). HTTP 200 when the same wallet already exists.

wallet_idstringrequired

Bytix wallet id.

payer_idstringrequired

Your user id. Only this payer can withdraw to the wallet.

payer_namestringoptional

Customer name, if sent.

labelstringoptional

Wallet name, if sent.

addressstringrequired

Destination address.

assetstringrequired

Ticker, for example USDT.

networkstringrequired

Network display name, for example Tron.

statusstringrequired

pending (waiting for the merchant), approved (payouts may use it), or rejected. A demo key's wallets are approved at once and only demo payouts can use them.

demobooleanrequired

True when registered with a demo key.

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, unknown asset/network, or an invalid address for that network.

40100HTTP 401optional

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

50300HTTP 503optional

Your wallets are still being prepared. Try again later.