BxBytix

POST/v1/orders/info

Query Order

Look up an order by cid or order_id. If both are sent, cid wins. Open orders past expiry are marked expired on this read and emit order.expired.

Request body

cidstringoptional

Public payment id returned at create. Preferred. If present, order_id is ignored.

order_idstringoptional

Your order ID. Used when cid 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. Quote fields populate after the payer selects an asset. HTTP 200 on success.

idstringoptional

Internal row id. Prefer cid for CRM storage; this value is not used on query.

cidstringrequired

Public payment id. Unique per order. Use it in query, webhooks, and support tickets.

tokenstringoptional

Hosted checkout token. Already embedded in checkout_url as /pay/chk_….

order_idstringrequired

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

payer_idstringoptional

Your user id. Grouped on the dashboard Customers page when present.

payer_emailstringoptional

Optional payer email. Stored only; not required to open checkout.

payer_namestringoptional

Optional payer display name on the payments list.

order_amountstringrequired

Fiat amount as a decimal string (for example 50.00).

order_currencystringrequired

Fiat currency. Send USD. Uppercased on store.

fiat_amountstringoptional

Alias of order_amount for older clients.

fiat_currencystringoptional

Alias of order_currency.

statusstringrequired

pending, awaiting_payment, paid_partial, paid, paid_over, expired, cancelled, failed, refunded.

remarkstringoptional

Free-text note from create. Not shown to the payer.

languagestringoptional

Checkout UI language. Defaults to the workspace setting (usually en).

chain_idstringoptional

Set after the payer selects an asset. Null on a fresh create.

token_idstringoptional

Asset identifier on that network after quote lock.

asset_symbolstringoptional

Quoted ticker, for example USDT. Null before the payer picks an asset.

network_namestringoptional

Quoted network display name, for example Tron.

crypto_amountstringoptional

Quoted crypto amount as a decimal string, or null before lock.

quote_ratestringoptional

Exchange rate used for the quote, or null.

payment_addressstringoptional

Address shown in checkout after quote lock. Do not reuse it for a different order.

expires_atstringoptional

ISO-8601 expiry. Open orders read after this become expired.

expire_timeintegeroptional

Same expiry as Unix milliseconds.

paid_atstringoptional

ISO-8601 paid time when status is paid or paid_over, else null.

checkout_urlstringrequired

Absolute URL for the 400×720 popup. Open it as returned — do not rewrite the host or token.

merchant_display_namestringoptional

Workspace name shown in the popup (Settings → Merchant).

merchant_logo_urlstringoptional

Logo URL shown in the popup, or null.

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 order for this workspace — missing both ids, or the id belongs to someone else.

PreviousCreate OrderNext Create Payout