DevelopersOsai website ↗
API v1
Console operations / API reference

Record Console Daily Close

Request and response reference for POST /v1/console/operations/daily-close-runs.

POST/v1/console/operations/daily-close-runs
Authentication: UnauthenticatedPermission: reconciliation.close.run
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 entry point does not require an existing session. Applicable onboarding, origin and verification policies still apply.

Request templatecURL
curl -X POST "$OSAI_CONSOLE_BASE_URL/v1/console/operations/daily-close-runs" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: <stable-operation-key>" \
  --data '{
  "command_id": "<command_id>",
  "day": "1",
  "reason": "<reason>"
}'

Parameters

NameLocationRequirementDescription
Idempotency-Keyheader · stringRequiredUse the value defined for this resource.
X-CSRF-Tokenheader · stringRequiredUse the value defined for this resource.

Request body

Send JSON with Content-Type: application/json. Nested field names identify their parent object; required markers apply within that object. Replace template values using the relevant resource and configured instrument rules.

FieldTypeDescription & constraints
command_idRequired in parent objectstringDefined by the resource contract.Pattern: ^[A-Za-z0-9:_-]{1,128}$
dayRequired in parent objectstringDefined by the resource contract.Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
reasonRequired in parent objectstringDefined by the resource contract.

Responses

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

200 · Immutable scoped evidence was recorded
FieldTypeDescription & constraints
command_idRequired in parent objectstringDefined by the resource contract.
report_idRequired in parent objectstringDefined by the resource contract.
dayRequired in parent objectstringDefined by the resource contract.
ledger_hashRequired in parent objectstringDefined by the resource contract.
statement_hashRequired in parent objectstringDefined by the resource contract.
ledger_captured_atRequired in parent objectstringdate-timeDefined by the resource contract.
recorded_atRequired in parent objectstringdate-timeDefined by the resource contract.
400 · Invalid bounded instruction/scope

No client body fields are defined for this response.

401 · Named human session required

No client body fields are defined for this response.

403 · Current authorization/MFA/CSRF denied or authority changed

No client body fields are defined for this response.

409 · Idempotency command conflict

No client body fields are defined for this response.

503 · Ledger/signed-source/persistence unavailable; no successful close inferred

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.