Get an OT settlement cycle

The cycle detail including the FI’s net position (projected from the single correlated instruction, never a sum), windows, and settlement moment.

GET /api/v1/siloc/cycles/{cycleId}

Get an OT settlement cycle

cURL

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/cycles/{cycleId} \
  --header 'Authorization: Bearer <token>'

200

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "movementDate": "<string>",
  "openedAt": "2023-11-07T05:31:56Z",
  "periodCode": "<string>",
  "product": "<string>",
  "status": "OPEN",
  "closedAt": "2023-11-07T05:31:56Z",
  "netPosition": {
    "amount": "<string>",
    "side": "DEBIT"
  },
  "settledAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

cycleId · string<uuid> · required

Cycle id.

Response

200

application/json

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.

Show child attributes

settledAt · string<date-time>

Settlement instant; omitted until settled.