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

# List OT settlement instructions (obligations)

> A cursor-paginated page of settlement obligations and their funding lifecycle state.



## OpenAPI

````yaml pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/settlement-instructions
openapi: 3.1.0
info:
  description: >-
    Interface OpenAPI 3.1 do Lerian SILOC, o trilho do lado do participante que
    conecta a instituição à liquidação interbancária diferida por compensação
    SILOC da Núclea. Abrange as capacidades de cobertura de liquidação, o
    registro de participantes e seu status operacional, o ciclo de vida dos
    certificados regulados, o relay de mensagens do domínio de cartões e seu
    status, o reenvio administrativo de falhas de relay estacionadas, os ciclos
    OT e as rodadas de recálculo, as instruções de liquidação, a ingestão de
    ROC, os alertas operacionais, as mudanças de agenda de contingência, a
    leitura do calendário de dias úteis e a trilha de auditoria.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: http://localhost:9820
security: []
paths:
  /api/v1/siloc/settlement-instructions:
    get:
      tags:
        - Settlement
      summary: List OT settlement instructions (obligations)
      description: >-
        A cursor-paginated page of settlement obligations and their funding
        lifecycle state.
      operationId: listSettlementInstructions
      parameters:
        - description: Restrict to one cycle.
          explode: false
          in: query
          name: cycleId
          schema:
            description: Restrict to one cycle.
            format: uuid
            type: string
        - description: Filter by lifecycle state.
          explode: false
          in: query
          name: state
          schema:
            description: Filter by lifecycle state.
            enum:
              - RECEIVED
              - FUNDING_REQUIRED
              - CREDIT_EXPECTED
              - SETTLED
              - FAILED
            type: string
        - description: Opaque pagination cursor.
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque pagination cursor.
            type: string
        - description: Page size (default 50, max 200).
          explode: false
          in: query
          name: limit
          schema:
            default: 50
            description: Page size (default 50, max 200).
            format: int64
            maximum: 200
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementInstructionListResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    SettlementInstructionListResponse:
      additionalProperties: false
      properties:
        hasMore:
          description: Whether more pages follow.
          type: boolean
        items:
          description: The page of instructions (never null).
          items:
            $ref: '#/components/schemas/SettlementInstructionResponse'
          type:
            - array
            - 'null'
        nextCursor:
          description: Opaque cursor for the next page; empty when exhausted.
          type: string
      required:
        - items
        - hasMore
      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
    SettlementInstructionResponse:
      additionalProperties: false
      properties:
        amountCanonical:
          description: Canonical NUMERIC(19,2), decimal string.
          type: string
        amountRaw:
          description: VlrLanc verbatim (validated magnitude).
          type: string
        createdAt:
          description: Row creation instant (list cursor key).
          format: date-time
          type: string
        cycleId:
          description: Correlated cycle id (1:1).
          format: uuid
          type: string
        depositDeadlineAt:
          description: Funding deadline (HrioLimDep on DtDep).
          format: date-time
          type: string
        id:
          description: Instruction id.
          format: uuid
          type: string
        movementDate:
          description: Business (reference) date, YYYY-MM-DD.
          type: string
        numCtrlLdl:
          description: Câmara control number (NumCtrlLDL).
          type: string
        numCtrlStr:
          description: STR reserve-transfer control number; omitted until linked.
          type: string
        pendingBeyondTwoCycles:
          description: >-
            True when still non-terminal and at least two later same-product
            cycles have CLOSED (a chronology flag, not a position).
          type: boolean
        periodCode:
          description: Operating-period token inherited from the cycle.
          type: string
        product:
          description: Rail product; always OT.
          type: string
        receivedAt:
          description: Terminal funding-ack local ingest instant; omitted until terminal.
          format: date-time
          type: string
        side:
          description: Explicit money direction (never derived from the amount sign).
          enum:
            - DEBIT
            - CREDIT
          type: string
        sourceNuOp:
          description: LDL0021 BCMSG operation number (idempotency key).
          type: string
        state:
          description: Funding lifecycle state.
          enum:
            - RECEIVED
            - FUNDING_REQUIRED
            - CREDIT_EXPECTED
            - SETTLED
            - FAILED
          type: string
        terminalAt:
          description: Regulator-authoritative terminal instant; omitted until terminal.
          format: date-time
          type: string
        terminalSourceEventId:
          description: ce-id of the terminalising SPB fact; omitted until terminal.
          format: uuid
          type: string
        terminalTimestampRaw:
          description: Terminal timestamp raw wire form; omitted until terminal.
          type: string
        terminalTimestampSource:
          description: Terminal timestamp provenance tag; omitted until terminal.
          type: string
        traceabilityId:
          description: >-
            num_ctrl_if (siloc_ot_traceability); correlates to the STR
            reserve-transfer outcome.
          type: string
      required:
        - id
        - cycleId
        - sourceNuOp
        - product
        - movementDate
        - periodCode
        - state
        - side
        - amountRaw
        - amountCanonical
        - traceabilityId
        - numCtrlLdl
        - depositDeadlineAt
        - pendingBeyondTwoCycles
        - createdAt
      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

````