> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml en/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}
openapi: 3.1.0
info:
  description: >-
    OpenAPI 3.1 surface for Lerian SILOC, the participant-side rail connecting
    the institution to Núclea's SILOC deferred-net interbank settlement. It
    covers settlement-coverage capabilities, participant registry and
    operational status, regulated-certificate lifecycle, the card-domain message
    relay and its status, administrative replay of parked relay failures, OT
    settlement cycles and recálculo rounds, settlement instructions, ROC
    ingestion, operational alerts, contingency schedule changes, business-day
    calendar reads, and the audit trail.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: http://localhost:9820
security: []
paths:
  /api/v1/siloc/cycles/{cycleId}:
    get:
      tags:
        - Settlement
      summary: Get an OT settlement cycle
      description: >-
        The cycle detail including the FI's net position (projected from the
        single correlated instruction, never a sum), windows, and settlement
        moment.
      operationId: getCycle
      parameters:
        - description: Cycle id.
          in: path
          name: cycleId
          required: true
          schema:
            description: Cycle id.
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CycleResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CycleResponse:
      additionalProperties: false
      properties:
        closedAt:
          description: Close instant; omitted until closed.
          format: date-time
          type: string
        createdAt:
          description: Row creation instant (list cursor key).
          format: date-time
          type: string
        id:
          description: Cycle id.
          format: uuid
          type: string
        movementDate:
          description: Business (reference) date, YYYY-MM-DD.
          type: string
        netPosition:
          $ref: '#/components/schemas/NetPosition'
          description: >-
            The FI's net position, from the single correlated instruction;
            omitted for a pre-intake OPEN cycle.
        openedAt:
          description: PAG0102 open instant (DtHrAbert).
          format: date-time
          type: string
        periodCode:
          description: Operating-period token (e.g. 01, 02).
          type: string
        product:
          description: Rail product; always OT.
          type: string
        settledAt:
          description: Settlement instant; omitted until settled.
          format: date-time
          type: string
        status:
          description: Cycle lifecycle.
          enum:
            - OPEN
            - SETTLING
            - RECALCULATING
            - SETTLED
            - CLOSED
          type: string
      required:
        - id
        - product
        - movementDate
        - periodCode
        - status
        - openedAt
        - createdAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    NetPosition:
      additionalProperties: false
      properties:
        amount:
          description: Canonical net amount (NUMERIC(19,2)), decimal string.
          type: string
        side:
          description: Money direction of the FI's net obligation.
          enum:
            - DEBIT
            - CREDIT
          type: string
      required:
        - side
        - amount
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````