Accounts / API reference
Get institution balances
Request and response reference for GET /v1/balances.
GET
/v1/balancesAuthentication: 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/balances" \
-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. |
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 · Balance view
| Field | Type | Description & constraints |
|---|---|---|
institution_idRequired in parent object | string | Defined by the resource contract. |
balancesRequired in parent object | array | Defined by the resource contract. |
balances[].currencyRequired in parent object | string | Defined by the resource contract. |
balances[].available_minorRequired in parent object | integer | Defined by the resource contract. |
balances[].held_minorRequired in parent object | integer | Defined by the resource contract. |
balances[].restricted_minorRequired in parent object | integer | Funds retained for controlled recovery and unavailable for spending. |
balances[].total_minorRequired in parent object | integer | Sum of available, held, and restricted minor units in this currency. |
request_idRequired in parent object | 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.