Skip to main content
GET
Get an OT settlement cycle

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

cycleId
string<uuid>
required

Cycle id.

Response

OK

createdAt
string<date-time>
required

Row creation instant (list cursor key).

id
string<uuid>
required

Cycle id.

movementDate
string
required

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

openedAt
string<date-time>
required

PAG0102 open instant (DtHrAbert).

periodCode
string
required

Operating-period token (e.g. 01, 02).

product
string
required

Rail product; always OT.

status
enum<string>
required

Cycle lifecycle.

Available options:
OPEN,
SETTLING,
RECALCULATING,
SETTLED,
CLOSED
closedAt
string<date-time>

Close instant; omitted until closed.

netPosition
object

The FI's net position, from the single correlated instruction; omitted for a pre-intake OPEN cycle.

settledAt
string<date-time>

Settlement instant; omitted until settled.