Read Console Recovery History
Request and response reference for GET /v1/console/operations/recovery-queue/{settlement_id}/events.
/v1/console/operations/recovery-queue/{settlement_id}/eventsRequest
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.
curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/console/operations/recovery-queue/$SETTLEMENT_ID/events" \
-H "Origin: $OSAI_APP_ORIGIN" \
--cookie "$OSAI_SESSION_COOKIE_FILE"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
settlement_id | path · string | Required | Use the value defined for this resource. |
limit | query · integer | Optional | Use the value defined for this resource. |
after | query · integer | Optional | Use the value defined for this resource. |
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 · Scoped owner read
| Field | Type | Description & constraints |
|---|---|---|
institution_idRequired in parent object | string | Defined by the resource contract. |
sourceRequired in parent object | string | Defined by the resource contract. |
observed_atRequired in parent object | string | Defined by the resource contract. |
source_as_ofRequired in parent object | string | null | Defined by the resource contract. |
external_finalityRequired in parent object | boolean | null | Defined by the resource contract. |
settlement_idRequired in parent object | string | Defined by the resource contract. |
owner_stateRequired in parent object | string | Defined by the resource contract. |
eventsRequired in parent object | array | Defined by the resource contract. |
events[].event_idRequired in parent object | string | Defined by the resource contract. |
events[].from_stateRequired in parent object | string | Defined by the resource contract. |
events[].to_stateRequired in parent object | string | Defined by the resource contract. |
events[].eventRequired in parent object | string | Defined by the resource contract. |
events[].sourceRequired in parent object | string | Defined by the resource contract. |
events[].occurred_atRequired in parent object | string | Defined by the resource contract. |
has_moreRequired in parent object | boolean | Defined by the resource contract. |
next_afterRequired in parent object | string | Defined by the resource contract. |
400 · Denied, invalid, missing or unavailable
No client body fields are defined for this response.
401 · Denied, invalid, missing or unavailable
No client body fields are defined for this response.
403 · Denied, invalid, missing or unavailable
No client body fields are defined for this response.
404 · Denied, invalid, missing or unavailable
No client body fields are defined for this response.
503 · Denied, invalid, missing or unavailable
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.