Pools & products
A product is a tradeable instrument identified by a slug. Today the only
product is ORBIS. A pool (internally, an offering) binds your partner
account to a product on a specific chain — and you can only place orders for a
product once its pool is ACTIVE.
The accept-before-you-trade model
Orbitum backoffice offers a pool to your partner account; a superadmin in your portal accepts it. Only then does the machine API let you order that product.
stateDiagram-v2
[*] --> OFFERED: backoffice offers the pool
OFFERED --> ACTIVE: superadmin accepts (portal)
OFFERED --> DECLINED: superadmin declines
ACTIVE --> SUSPENDED: backoffice suspends
SUSPENDED --> ACTIVE: backoffice resumes
ACTIVE --> WITHDRAWN: backoffice withdraws
note right of ACTIVE
Only an ACTIVE pool lets the
machine API place orders for
this product.
end note
You never pass a pool id to the order API — you send the product slug
("product": "ORBIS"), and the API resolves it to your ACTIVE pool.
What you get back if the pool isn't ACTIVE
Ordering a product whose pool isn't ACTIVE returns a distinct, non-retryable error at order time — fix it by accepting the pool in the portal, not by retrying:
| Pool state | Error code | HTTP |
|---|---|---|
| Not offered / declined / withdrawn | CEX_PRODUCT_NOT_OFFERED | 404 |
| Offered, not yet accepted | CEX_OFFERING_NOT_ACCEPTED | 409 |
| Suspended | CEX_OFFERING_SUSPENDED | 409 |
| Chain not served by your omnibus | CEX_OFFERING_CHAIN_UNSERVED | 409 |
To accept an offered pool, follow Onboarding → Accept a pool.