POST/v1/payouts/info
Query Payout
Look up a payout by payout_id or id. If both are sent, id wins.
Request body
idstringoptionalBytix payout id returned at create. If present, payout_id is used only as fallback.
payout_idstringoptionalYour payout ID. Used when id is omitted. Send at least one of the two.
Headers
AuthorizationheaderrequiredBearer pk_… from dashboard Settings → Developer.
Content-Typeheaderoptionalapplication/json on POST bodies. Not required on GET.
Response data
Same data shape as create. HTTP 200 on success.
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.
40100HTTP 401optionalMissing or invalid API key.
40400HTTP 404optionalNo payout for this workspace.