DevelopersOsai website ↗
API v1
Events & reliability

Idempotency

Prevent duplicate financial effects across retries and uncertain outcomes.

One key per logical request

Send Idempotency-Key on quote creation and acceptance, beneficiary registration, webhook configuration and replay. Retain the same key and canonical request when retrying an operation. Keys are scoped by institution and operation.

Recognize conflicts

SituationHandling
Same key and requestReplay the original result when recorded.
Same key, different requestIDEMPOTENCY_CONFLICT; do not overwrite the first request.
Request in progressIDEMPOTENCY_IN_PROGRESS; back off and query.
Timeout after submissionKeep the key and original references; investigate the original outcome.

Exchange command identity

Exchange instructions also use command_id and institution-scoped client_order_id. Retain preview IDs and hashes through approval. Cancel and replace require expected versions. A new command ID is not a workaround for unresolved work.

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.