DevelopersOsai website ↗
API v1
Financial workflows

Beneficiaries

Register beneficiaries and coordinate their institutional approval lifecycle.

Register for review

POST /v1/beneficiaries registers an institution-scoped beneficiary for review and returns HTTP 202 when accepted. Registration does not move funds or establish approval for a settlement route.

Controlled changes

Console proposals, approvals, rejections and disables use permissions, expected versions and recorded reasons. A maker cannot substitute their own approval for the independent checker. Read current beneficiary state before referencing it in acceptance.

Historical references

Keep beneficiary IDs linked to original instructions. Disabling a beneficiary must not rewrite completed transaction history. Use current eligibility for new instructions and historical references for reconciliation.

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.