POST/v1/payouts/info

Query Payout

Look up a payout by payout_id or id. If both are sent, id wins.

Request body

idstringoptional

Bytix payout id returned at create. If present, payout_id is used only as fallback.

payout_idstringoptional

Your payout ID. Used when id is omitted. Send at least one of the two.

Headers

Authorizationheaderrequired

Bearer pk_… from dashboard Settings → Developer.

Content-Typeheaderoptional

application/json on POST bodies. Not required on GET.

Response data

Same data shape as create. HTTP 200 on success.

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.

40100HTTP 401optional

Missing or invalid API key.

40400HTTP 404optional

No payout for this workspace.

Example request

http://127.0.0.1:43120/v1/payouts/info

json

{ "payout_id": "wd_001"}

Response example

application/json

json

{
  "code": "00000",
  "msg": "ok",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxx",
    "payout_id": "wd_001",
    "amount": "25",
    "currency": "USD",
    "asset": "USDT",
    "network": "Tron",
    "address": "T...",
    "crypto_amount": "25",
    "quote_rate": "1",
    "status": "completed",
    "txid": "0xab12cd34ef567890ab12cd34ef567890ab12cd34",
    "payer_id": "user_1001",
    "created_at": "2026-09-16T21:05:00.000Z"}
}

PreviousCreate Payout Next Available Balance