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



## OpenAPI

````yaml es/openapi/v3-current/siloc.yaml get /api/v1/siloc/settlement-instructions/{instructionId}
openapi: 3.1.0
info:
  description: >-
    Interfaz OpenAPI 3.1 de Lerian SILOC, el riel del lado del participante que
    conecta la institución con la liquidación interbancaria diferida por neteo
    SILOC de Núclea. Cubre las capacidades de cobertura de liquidación, el
    registro de participantes y su estado operativo, el ciclo de vida de los
    certificados regulados, el relay de mensajes del dominio de tarjetas y su
    estado, el reenvío administrativo de fallos de relay estacionados, los
    ciclos OT y las rondas de recálculo, las instrucciones de liquidación, la
    ingestión de ROC, las alertas operacionales, los cambios de agenda de
    contingencia, la lectura del calendario de días útiles y la trilla de
    auditoría.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: http://localhost:9820
security: []
paths:
  /api/v1/siloc/settlement-instructions/{instructionId}:
    get:
      tags:
        - Settlement
      summary: Get an OT settlement instruction
      operationId: getSettlementInstruction
      parameters:
        - description: Instruction id.
          in: path
          name: instructionId
          required: true
          schema:
            description: Instruction id.
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementInstructionResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    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
    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
    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

````