DevelopersOsai website ↗
API v1
Console operations / API reference

Read Console Routing

Request and response reference for GET /v1/console/operations/routing.

GET/v1/console/operations/routing
Authentication: Console sessionPermission: operations.read
Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.

Request

This interface uses an approved institutional session, not a financial API key. Session writes also need Origin and CSRF protection. Use the JavaScript sample within an authorized browser integration.

Request templatecURL
curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/console/operations/routing" \
  -H "Origin: $OSAI_APP_ORIGIN" \
  --cookie "$OSAI_SESSION_COOKIE_FILE"

Parameters

No endpoint-specific path or query parameters are defined. Authentication and access policy still apply.

Request body

This operation does not define a JSON request body.

Responses

Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.

200 · Institution-scoped owner evidence; no external finality inferred
FieldTypeDescription & constraints
institution_idRequired in parent objectstringDefined by the resource contract.
observed_atRequired in parent objectstringDefined by the resource contract.
sourceRequired in parent objectstringDefined by the resource contract.
routesRequired in parent objectarrayDefined by the resource contract.
routes[].route_idRequired in parent objectstringDefined by the resource contract.
routes[].versionRequired in parent objectstringDefined by the resource contract.
routes[].config_hashRequired in parent objectstringDefined by the resource contract.
routes[].provider_idRequired in parent objectstringDefined by the resource contract.
routes[].source_currencyRequired in parent objectstringDefined by the resource contract.
routes[].destination_currencyRequired in parent objectstringDefined by the resource contract.
routes[].healthRequired in parent objectstringDefined by the resource contract.
routes[].health_observed_atRequired in parent objectstringDefined by the resource contract.
routes[].health_valid_untilRequired in parent objectstringDefined by the resource contract.
routes[].configured_source_capacity_minorRequired in parent objectstringDefined by the resource contract.
routes[].capacity_kindRequired in parent objectstringDefined by the resource contract.
routes[].minimum_source_principal_minorRequired in parent objectstringDefined by the resource contract.
routes[].maximum_source_principal_minorRequired in parent objectstringDefined by the resource contract.
routes[].enabledRequired in parent objectbooleanDefined by the resource contract.
routes[].health_staleRequired in parent objectbooleanDefined by the resource contract.
routes[].external_liquidityRequired in parent objectobject | nullDefined by the resource contract.
routes[].provider_observationRequired in parent objectobject | nullDefined by the resource contract.
routes[].provider_observation.collection_fenceRequired in parent objectstringDefined by the resource contract.
routes[].provider_observation.collection_started_atRequired in parent objectstringDefined by the resource contract.
routes[].provider_observation.valid_untilRequired in parent objectstringDefined by the resource contract.
routes[].provider_observation.evidence_hashRequired in parent objectstringDefined by the resource contract.
routes[].provider_observation.usable_when_collectedRequired in parent objectbooleanDefined by the resource contract.
routes[].provider_observation.staleRequired in parent objectbooleanDefined by the resource contract.
pause_proposalsRequired in parent objectarrayDefined by the resource contract.
pause_proposals[].change_idRequired in parent objectstringDefined by the resource contract.
pause_proposals[].route_idRequired in parent objectstringDefined by the resource contract.
pause_proposals[].versionRequired in parent objectstringDefined by the resource contract.
pause_proposals[].makerRequired in parent objectstringDefined by the resource contract.
incidentsRequired in parent objectarrayDefined by the resource contract.
incidents[].incident_idRequired in parent objectstringDefined by the resource contract.
incidents[].statusRequired in parent objectstringDefined by the resource contract.
incidents[].updated_atRequired in parent objectstringDefined by the resource contract.
400 · Invalid query

No client body fields are defined for this response.

401 · Session required

No client body fields are defined for this response.

403 · Permission denied

No client body fields are defined for this response.

503 · Owner unavailable; no scenario fallback

No client body fields are defined for this response.

Retries & recovery

Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.

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.