Settlement reports / API reference
List terminal settlement outcomes for the institution
Request and response reference for GET /v1/reports/settlements.
GET
/v1/reports/settlementsAuthentication: API key
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
Keep API keys in your backend. Required entitlements and institution scope still apply.
curl -X GET "$OSAI_API_BASE_URL/v1/reports/settlements" \
-H "Authorization: ApiKey $OSAI_PUBLIC_ID:$OSAI_API_SECRET"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
Authorization | header · string | Required | Use the value defined for this resource. |
X-Request-Id | header · string | Optional | Use the value defined for this resource. |
page | query · integer | Optional | Use the value defined for this resource. |
page_size | query · integer | Optional | Use the value defined for this resource. |
from | query · string | Optional | Inclusive lower bound on trade creation time or terminal settlement time, according to the endpoint. |
to | query · string | Optional | Exclusive upper bound on trade creation time or terminal settlement time, according to the endpoint. |
currency | query · string | Optional | Exact currency filter; trade lists use sell/base currency and settlement reports use settlement currency. |
status | query · string | Optional | Exact canonical status for the endpoint's 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 · Terminal settlement report page
| Field | Type | Description & constraints |
|---|---|---|
itemsRequired in parent object | array | Defined by the resource contract. |
items[].settlement_idRequired in parent object | string | Defined by the resource contract. |
items[].trade_idRequired in parent object | string | Defined by the resource contract. |
items[].quote_idRequired in parent object | string | Defined by the resource contract. |
items[].statusRequired in parent object | string | Defined by the resource contract.Values: CONFIRMED, FAILED, RETURNED, REVERSED |
items[].amount_minorRequired in parent object | integer | Defined by the resource contract. |
items[].currencyRequired in parent object | string | Defined by the resource contract. |
items[].occurred_atRequired in parent object | stringdate-time | Defined by the resource contract. |
pageRequired in parent object | integer | Defined by the resource contract. |
page_sizeRequired in parent object | integer | Defined by the resource contract. |
totalRequired in parent object | integer | Defined by the resource contract. |
request_idRequired in parent object | string | Defined by the resource contract. |
400 · Validation failure
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | object | Defined by the resource contract. |
error.codeRequired in parent object | string | Defined by the resource contract. |
error.messageRequired in parent object | string | Defined by the resource contract. |
error.request_idRequired in parent object | string | Defined by the resource contract. |
503 · Settlement report service 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.