Skip to main content
GET
Get an OT settlement instruction

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

instructionId
string<uuid>
required

Instruction id.

Response

OK

amountCanonical
string
required

Canonical NUMERIC(19,2), decimal string.

amountRaw
string
required

VlrLanc verbatim (validated magnitude).

createdAt
string<date-time>
required

Row creation instant (list cursor key).

cycleId
string<uuid>
required

Correlated cycle id (1:1).

depositDeadlineAt
string<date-time>
required

Funding deadline (HrioLimDep on DtDep).

id
string<uuid>
required

Instruction id.

movementDate
string
required

Business (reference) date, YYYY-MM-DD.

numCtrlLdl
string
required

Câmara control number (NumCtrlLDL).

pendingBeyondTwoCycles
boolean
required

True when still non-terminal and at least two later same-product cycles have CLOSED (a chronology flag, not a position).

periodCode
string
required

Operating-period token inherited from the cycle.

product
string
required

Rail product; always OT.

side
enum<string>
required

Explicit money direction (never derived from the amount sign).

Available options:
DEBIT,
CREDIT
sourceNuOp
string
required

LDL0021 BCMSG operation number (idempotency key).

state
enum<string>
required

Funding lifecycle state.

Available options:
RECEIVED,
FUNDING_REQUIRED,
CREDIT_EXPECTED,
SETTLED,
FAILED
traceabilityId
string
required

num_ctrl_if (siloc_ot_traceability); correlates to the STR reserve-transfer outcome.

numCtrlStr
string

STR reserve-transfer control number; omitted until linked.

receivedAt
string<date-time>

Terminal funding-ack local ingest instant; omitted until terminal.

terminalAt
string<date-time>

Regulator-authoritative terminal instant; omitted until terminal.

terminalSourceEventId
string<uuid>

ce-id of the terminalising SPB fact; omitted until terminal.

terminalTimestampRaw
string

Terminal timestamp raw wire form; omitted until terminal.

terminalTimestampSource
string

Terminal timestamp provenance tag; omitted until terminal.