Console operations / API reference

Capture Internal Statement

Request and response reference for POST /v1/console/operations/statements.

POST/v1/console/operations/statements

Authentication: UnauthenticatedPermission: reports.statements.create

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 entry point does not require an existing session. Applicable onboarding, origin and verification policies still apply.

Request templatecURL

curl -X POST "$OSAI_CONSOLE_BASE_URL/v1/console/operations/statements" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: <stable-operation-key>" \
  --data '{
  "command_id": "<command_id>",
  "from": "<RFC3339 timestamp>",
  "to": "<RFC3339 timestamp>",
  "reason": "<reason>"
}'

Parameters

Name	Location	Requirement	Description
`Idempotency-Key`	header · string	Required	Use the value defined for this resource.
`X-CSRF-Token`	header · string	Required	Use the value defined for this resource.

Request body

Send JSON with Content-Type: application/json. Nested field names identify their parent object; required markers apply within that object. Replace template values using the relevant resource and configured instrument rules.

Field	Type	Description & constraints
`command_id`Required in parent object	`string`	Defined by the resource contract.Pattern: `^[A-Za-z0-9:_-]{1,128}$`
`from`Required in parent object	`string`date-time	Defined by the resource contract.
`to`Required in parent object	`string`date-time	Defined by the resource contract.
`currency`Optional	`string`	Defined by the resource contract.Pattern: `^[A-Z]{3}$`
`reason`Required in parent object	`string`	Defined by the resource contract.

Responses

Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.

200 · Current-human scoped internal Ledger statement response

Field	Type	Description & constraints
`statement_id`Required in parent object	`string`	Defined by the resource contract.
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`command_id`Required in parent object	`string`	Defined by the resource contract.
`from`Required in parent object	`string`date-time	Defined by the resource contract.
`to`Required in parent object	`string`date-time	Defined by the resource contract.
`currency`Optional	`string`	Defined by the resource contract.
`captured_at`Required in parent object	`string`date-time	Defined by the resource contract.
`source`Required in parent object	`string`	Defined by the resource contract.Values: INTERNAL_LEDGER
`consistency`Required in parent object	`string`	Defined by the resource contract.Values: SINGLE_STATEMENT_MVCC
`sign_convention`Required in parent object	`string`	Defined by the resource contract.Values: CUSTOMER_LIABILITY_CREDIT_MINUS_DEBIT
`certified`Required in parent object	`boolean`	Defined by the resource contract.Values: false
`content_hash`Required in parent object	`string`	Defined by the resource contract.Pattern: `^[0-9a-f]{64}$`
`accounts`Required in parent object	`array`	Defined by the resource contract.
`accounts[].account_code`Required in parent object	`string`	Defined by the resource contract.
`accounts[].currency`Required in parent object	`string`	Defined by the resource contract.
`accounts[].opening_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`accounts[].debits_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`accounts[].credits_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`accounts[].closing_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`entries`Required in parent object	`array`	Defined by the resource contract.
`entries[].entry_id`Required in parent object	`string`	Defined by the resource contract.Pattern: `^[0-9]+$`
`entries[].journal_id`Required in parent object	`string`	Defined by the resource contract.
`entries[].trade_id`Required in parent object	`string`	Defined by the resource contract.
`entries[].posted_at`Required in parent object	`string`date-time	Defined by the resource contract.
`entries[].account_code`Required in parent object	`string`	Defined by the resource contract.
`entries[].currency`Required in parent object	`string`	Defined by the resource contract.
`entries[].debit_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`entries[].credit_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`metrics`Required in parent object	`array`	Defined by the resource contract.
`metrics[].currency`Required in parent object	`string`	Defined by the resource contract.
`metrics[].debits_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`metrics[].credits_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`metrics[].net_change_minor`Required in parent object	`string`	Defined by the resource contract.Pattern: `^-?[0-9]+$`
`posted_journal_count`Required in parent object	`integer`	Defined by the resource contract.Minimum: 0Maximum: 2000

401 · Named session required