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 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.
No endpoint-specific path or query parameters are defined. Authentication and access policy still apply.
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 · Verified human scoped owner projection
Field
Type
Description & constraints
institution_idRequired in parent object
string
Defined by the resource contract.
observed_atRequired in parent object
stringdate-time
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
string
Defined by the resource contract.Pattern: ^-?[0-9]+$
balances[].held_minorRequired in parent object
string
Defined by the resource contract.Pattern: ^-?[0-9]+$
balances[].restricted_minorRequired in parent object
string
Defined by the resource contract.Pattern: ^-?[0-9]+$
balances[].total_minorRequired in parent object
string
Defined by the resource contract.Pattern: ^-?[0-9]+$
sourceRequired in parent object
string
Defined by the resource contract.Values: INTERNAL_LEDGER_READ_MODEL
source_as_ofRequired in parent object
string | null
Defined by the resource contract.
partner_balanceRequired in parent object
string | null
Defined by the resource contract.
reconciledRequired in parent object
boolean | null
Defined by the resource contract.
400 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired in parent object
string
Defined by the resource contract.
401 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired in parent object
string
Defined by the resource contract.
403 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired in parent object
string
Defined by the resource contract.
404 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired in parent object
string
Defined by the resource contract.
405 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired in parent object
string
Defined by the resource contract.
502 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired in parent object
string
Defined by the resource contract.
503 · Invalid, denied, missing, read-only or unavailable; never an empty success
Field
Type
Description & constraints
codeRequired 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.