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_idstringrequiredYour user id. Only this payer can withdraw to the wallet.
addressstringrequiredDestination address on that network. Checked immediately; an invalid address is refused.
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.
labelstringoptionalOptional name for the wallet, shown to the merchant.
payer_namestringoptionalOptional customer name, shown to the merchant.
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 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_idstringrequiredBytix wallet id.
payer_idstringrequiredYour user id. Only this payer can withdraw to the wallet.
payer_namestringoptionalCustomer name, if sent.
labelstringoptionalWallet name, if sent.
addressstringrequiredDestination address.
assetstringrequiredTicker, for example USDT.
networkstringrequiredNetwork display name, for example Tron.
statusstringrequiredpending (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.
demobooleanrequiredTrue when registered with a demo key.
created_atstringrequiredISO-8601 create time.
Errors
Failures still return JSON. Read code, not only the HTTP status. Full table: Errors.
40000HTTP 400optionalValidation: missing fields, unknown asset/network, or an invalid address for that network.
40100HTTP 401optionalMissing or invalid API key, or the workspace is not active.
50300HTTP 503optionalYour wallets are still being prepared. Try again later.