Sign in

v2

latestOpenAPI 3.1.0Proprietary2026-07-3191563.2 KB
Orders

Get an order

Fetch one order by id. Orders are tenant-isolated: another tenant's id (or an unknown/malformed id) returns 404 — never leaking its existence.

get/v1/orders/{id}

Path parameters

idstring uuid required

The order id (UUID, also used as the on-chain payment memo).

Response

The order.

order_idstring uuid required
status'received' | 'awaiting_payment' | 'paid' | 'reserved' | 'swapping' | 'funding' | 'purchasing' | 'fulfilling' | 'completed' | 'delivered' | 'failed' | 'reversed' | 'expired' | 'held' | 'cancelled' required

Lifecycle status. awaiting_payment is the only cancellable state.

type'stars' | 'premium' required
recipient_usernamestring required
quantityinteger nullable
monthsinteger nullable
amount_tonstring nullable

The TON fulfilment cost (decimal string), when known.

payment_txstring nullable
purchase_txstring nullable
failure_reasonstring nullable

Why the order ended where it did, when not delivered: underpaid / overpaid / no_memo / wrong_memo (→ failed, funds reversed), undeliverable (→ reversed, funds reversed), or expired. Null otherwise. See Reversals & delivery.

reversal_txstring nullable
telegram_messagestring nullable

A verbatim user-facing message from Fragment, when present.

created_atstring date-time
updated_atstring date-time
expires_atstring date-time nullable

Non-null only while awaiting_payment.