Endpoints
All endpoints require JWT authentication (except
/health and /auth/token). See Authentication and API Conventions for details on headers, pagination, error handling, and response envelopes.
Quick Example: Order to Settlement
1. Create an Order
PENDING status with intent_id assigned.
2. Accept a Quote
QUOTED with fx_rate, source_amount_actual, and market_maker_party_id populated.
3. Verify Settlement
PollGET /api/v1/orders/{intent_id} until status is SETTLED:
Order Status Lifecycle
Failure Reasons
Real-Time Events (SSE)
Connect toGET /api/v1/orders/events for real-time updates:
Filter to a specific order:
?intent_id={uuid}