Settlement reports / API reference

Get settlement by ID

Request and response reference for GET /v1/settlements/{settlement_id}.

GET/v1/settlements/{settlement_id}

Authentication: 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.

Request templatecURL

curl -X GET "$OSAI_API_BASE_URL/v1/settlements/$SETTLEMENT_ID" \
  -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.
`settlement_id`	path · string	Required	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 · Settlement found

Field	Type	Description & constraints
`settlement_id`Required in parent object	`string`	Defined by the resource contract.
`trade_id`Required in parent object	`string`	Defined by the resource contract.
`quote_id`Required in parent object	`string`	Defined by the resource contract.
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`status`Required in parent object	`string`	Defined by the resource contract.
`beneficiary`Optional	`string`	Defined by the resource contract.
`amount_minor`Required in parent object	`integer`	Defined by the resource contract.
`currency`Required in parent object	`string`	Defined by the resource contract.
`purpose`Optional	`string`	Defined by the resource contract.
`request_id`Optional	`string`	Defined by the resource contract.

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.

Error handling →Idempotency →