Concepts
Domain vocabulary used throughout the API. Each term is defined once here; the reference pages link back to these definitions.
| Term | Meaning |
|---|---|
| Product | A tradeable instrument, identified by a slug. Today the only product is ORBIS. |
| Pool / offering | A binding of your partner account to a product. You can only trade a product once its offering is ACTIVE (accepted). See Pools & products. |
| Price-lock | The price fixed at order placement, taken from the latest POSTED NAV. See Price-lock & reservation. |
| Reservation / hold | ORBIS units reserved for a SUBSCRIBE order until it settles or is cancelled. |
| NAV | Net asset value — the POSTED base price used to lock an order. |
| Daily cutoff | The time-of-day boundary that groups orders into a settlement batch. |
| Settlement batch | The daily reconciliation of orders into net delivery, identified CXS-YYYYMMDD-NNN. See Settlement. |
| Omnibus account | Your registered on-chain delivery address, confirmed by Orbitum backoffice. See Omnibus. |
| Daily cap | A per-partner daily USD limit on SUBSCRIBE volume. See Daily caps. |
| Envelope | Success responses are wrapped { requestId, data }. See Envelope & pagination. |
| Keyset pagination | List reads page via an opaque meta.nextCursor, not an offset. |
exchangeUserId | Your identifier for the end user an order belongs to (1–128 chars). |
clientOrderId | Your idempotency key for an order (see Idempotency). |
Guides in this section
- Pools & products — the accept-before-you-trade model
- Price-lock & reservation
- Daily cutoff & settlement
- Omnibus registration
- Daily caps
- Response envelope & pagination