DevelopersOsai website ↗
API v1
Events & reliability

Event payloads

Understand the customer event envelope and business transitions behind subscriptions.

Common envelope

Deliveries identify event_id, event_type, event_version, correlation_id, payload and occurred_at. Read type and version together. Preserve the raw body for verification before parsing. The example shows envelope fields, not a complete type-specific payload.

Envelope field shapejson
{
  "event_id": "<event-id>",
  "event_type": "trade.accepted",
  "event_version": "v1",
  "correlation_id": "<correlation-id>",
  "payload": {
    "trade_id": "<trade-id>"
  },
  "occurred_at": "<RFC3339 timestamp>"
}

Customer lifecycle events

EventInterpretation
quote.expiredQuote expiry; obtain new terms before acceptance.
trade.acceptedInstruction accepted, not settled.
trade.funding_requiredFunding is needed before execution.
trade.fundedThe funding transition has been recorded.
trade.settlement_processingSettlement processing has begun.
trade.settledThe workflow has recorded confirmed settlement.

Subscription scope

Subscribe to event types enabled for your workflow. Payload detail depends on type and version; read the canonical resource for its full state. Do not infer FX execution, a return or reversal from an unrelated event. Book events and private order reads are separate interfaces.

16 suggested pages

Get startedIntroductionIntegrate institutional FX and stablecoin trading with quotes, orders, market data, account records and settlement reporting.Get startedQuickstartMake an authenticated read, request a quote and follow an instruction without losing its original references.Get startedAuthenticationUse the correct authentication scheme for API credentials, Console sessions and market-data feeds.Get startedErrorsDistinguish invalid inputs, denied access, conflicts, rate limits and uncertain outcomes.Get startedRate limitsUse response headers, bounded concurrency and backoff rather than repeated bursts.Get startedAmounts & precisionKeep minor-unit money, fixed-point FX rates and instrument-scaled quantities exact.Get startedPagination & recoveryUse each resource’s pagination model and preserve stable recovery checkpoints.Financial workflowsQuotes & acceptanceRequest explicit FX economics, review conditions and retain accepted terms.Financial workflowsTrade lifecycleTrack funding, execution and settlement as distinct business transitions.Financial workflowsBalances & transactionsRead institutional financial positions and reconcile movements by currency.Financial workflowsBeneficiariesRegister beneficiaries and coordinate their institutional approval lifecycle.Financial workflowsCredential managementCreate, inspect, rotate and revoke application credentials without exposing secrets.Events & reliabilityIdempotencyPrevent duplicate financial effects across retries and uncertain outcomes.Events & reliabilityWebhooks & verificationVerify deliveries, persist original events and make downstream processing idempotent.Events & reliabilityEvent payloadsUnderstand the customer event envelope and business transitions behind subscriptions.Events & reliabilityDelivery retries & replayRepair webhook delivery without creating a second business event.