> ## 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 a settlement instruction with its rounds and STR proof

> Returns one card settlement instruction, every round its LDL0021s opened, the STR launches recorded for each round, and the LDL0022 fields the client's SPB needs for the current round (it mints NumCtrlIF itself). An unknown id answers 404. RBAC: funding:read.



## OpenAPI

````yaml /es/openapi/v3-current/slc.yaml get /v1/funding/settlement-instructions/{instructionId}
openapi: 3.1.0
info:
  description: >-
    API for Lerian SLC — the participant-side rail that connects the institution
    to Núclea's SLC card settlement.
  title: Lerian SLC API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: >-
      Settlement operation lifecycle — create, list, query, and control the
      NUliquid-tracked card operations (NUliquid = the 21-position id Núclea
      assigns each accepted operation) through the state machine.
    name: Operations
  - description: >-
      Participant catalog — the acquirers, sub-acquirers, IF Domicílio (bank
      where the merchant receives its sales), and settlement FIs (financial
      institutions) that take part in card settlement.
    name: Participants
  - description: >-
      Card arrangements (bandeira/scheme configurations, e.g. Visa/Master/Elo)
      attached to a participant.
    name: Arrangements
  - description: >-
      Regulated transport orchestration to Núclea's SLC — dispatch, recovery,
      retransmission, and connectivity testing over managed file-transfer,
      message-broker, and REST.
    name: Connectivity
  - description: >-
      Multilateral netting clearing positions — the net amount each participant
      settles per STR cycle (STR = Banco Central reserves-transfer system).
    name: Clearing
  - description: >-
      SaaS BYOK (Bring Your Own Key) signing-key provisioning — import
      parameters and register the client's ICP-Brasil server-type certificate
      material used to sign ASLC files (RSA, at least 2048 bits, and valid at
      the moment of import — all three are enforced); the SLC never receives the
      private key in cleartext.
    name: SigningKey
  - description: >-
      ASLC file intake and status — passthrough submission and processing status
      of the official Núclea card-settlement XML files (ASLC = Arquivo do
      Sistema de Liquidação de Cartões).
    name: Files
  - description: >-
      Read-only introspection of the embedded Núclea ASLC/RSFN (National
      Financial System Network) XSD schemas used to validate outbound and
      inbound messages.
    name: XSD Schemas
  - description: Read-only regulatory, compliance, and operational settlement reports.
    name: Reports
  - description: >-
      Outbound business-event webhook subscriptions and delivery management for
      consumers (client ledgers — optional).
    name: Webhooks
  - description: Administrative operations — dead-letter-queue inspection/replay.
    name: Admin
  - description: >-
      LBTR (gross real-time settlement) commands and reads — position requests,
      confirmation or divergence of announced settlement results, and
      receivables-anticipation transfers exchanged with the câmara.
    name: LBTR
  - description: >-
      Card settlement funding — the settlement instructions to be funded in STR
      and the declaration of each deposit's confirmation.
    name: Funding
  - description: >-
      IF Domicílio (the bank where the merchant receives its sales) view — the
      settlements Núclea notified it of and its confirmation or refusal of them.
    name: Domicile
  - description: >-
      Read-only introspection of the settlement time grid (the windows in which
      each message type may be sent).
    name: Schedule
paths:
  /v1/funding/settlement-instructions/{instructionId}:
    get:
      tags:
        - Funding
      summary: Get a settlement instruction with its rounds and STR proof
      description: >-
        Returns one card settlement instruction, every round its LDL0021s
        opened, the STR launches recorded for each round, and the LDL0022 fields
        the client's SPB needs for the current round (it mints NumCtrlIF
        itself). An unknown id answers 404. RBAC: funding:read.
      operationId: getSettlementInstruction
      parameters:
        - description: Settlement instruction id (UUID).
          in: path
          name: instructionId
          required: true
          schema:
            description: Settlement instruction id (UUID).
            examples:
              - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementInstructionDetailResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Not Implemented: this capability is not part of this deployment.
            Operations are registered unconditionally so the published contract
            is identical across deploy shapes; when the capability behind one
            did not compose here (authentication disabled, no database, no
            outbound transport, or the feature switched off) it answers this
            coded SLC-0012 problem. It is definitive for this deployment:
            retrying does not help, and the `detail` is deliberately scrubbed
            (any status >= 500 is).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    SettlementInstructionDetailResponse:
      additionalProperties: false
      properties:
        currency:
          description: Amount currency.
          type: string
        cycle:
          description: CodPerOperac of the deposit cycle.
          type: string
        depositDeadline:
          description: LDL0021 DtDep + HrioLimDep (RFC3339).
          type: string
        depositRequest:
          $ref: '#/components/schemas/DepositRequestResponse'
          description: >-
            The LDL0022 fields for the current round; omitted when the round
            asks for no deposit.
        depositSender:
          description: >-
            Who sends the card deposits in this installation: LERIAN_SPB (Lerian
            SPB) or CLIENT_SPB (the client's own SPB).
          enum:
            - LERIAN_SPB
            - CLIENT_SPB
          type: string
        id:
          description: Settlement instruction id.
          type: string
        netAmountCents:
          description: >-
            Value of the current round as the LDL0021 carried it, in cents
            (negative = the IF deposits).
          format: int64
          type: integer
        notifiedAt:
          description: When the client was notified of the current round (RFC3339).
          type: string
        participantIspb:
          description: ISPB of the IF the deposit value was informed to.
          type: string
        productCode:
          description: CodProdt of the LDL0021.
          type: string
        referenceDate:
          description: Settlement business day (YYYY-MM-DD).
          type: string
        round:
          description: Current round.
          format: int64
          type: integer
        rounds:
          description: Every round, oldest first.
          items:
            $ref: '#/components/schemas/InstructionRoundResponse'
          type: array
        state:
          description: PENDING, NOTIFIED, DEPOSITED or SETTLED.
          type: string
        updatedAt:
          description: Last change (RFC3339).
          type: string
      required:
        - rounds
        - depositSender
        - id
        - referenceDate
        - cycle
        - state
        - round
        - netAmountCents
        - currency
        - updatedAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        correlationId:
          description: Request-scoped correlation identifier echoing X-Request-ID.
          examples:
            - req-7a3f9c2e
          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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      required:
        - correlationId
      type: object
    DepositRequestResponse:
      additionalProperties: false
      properties:
        codProdt:
          description: CodProdt, from the LDL0021.
          type: string
        dtMovto:
          description: 'DtMovto: the settlement business day.'
          type: string
        ispbIF:
          description: 'ISPBIF: the IF that deposits.'
          type: string
        ispbLDL:
          description: >-
            ISPBLDL: the câmara, from the LDL0021. Omitted for an instruction
            recorded before the rail kept it.
          type: string
        round:
          description: The round the deposit answers.
          format: int64
          type: integer
        vlrLanc:
          description: 'VlrLanc: the value of the round (Valor).'
          type: string
      required:
        - round
        - vlrLanc
        - dtMovto
      type: object
    InstructionRoundResponse:
      additionalProperties: false
      properties:
        depositDeadline:
          description: The round's deposit deadline (RFC3339).
          type: string
        evidence:
          description: The STR launches recorded for this round, oldest first.
          items:
            $ref: '#/components/schemas/RoundEvidenceResponse'
          type: array
        ldlAt:
          description: DtHrLDL of the round's newest LDL0021 (RFC3339).
          type: string
        netAmountCents:
          description: >-
            Value this round's LDL0021 carried, in cents (negative = the IF
            deposits).
          format: int64
          type: integer
        openedAt:
          description: When the rail opened the round (RFC3339).
          type: string
        previousNetAmountCents:
          description: Value of the round this one replaced, as received.
          format: int64
          type: integer
        round:
          description: Round number, 1 for the first LDL0021.
          format: int64
          type: integer
        sourceMessageId:
          description: NUOp of the LDL0021 that opened the round.
          type: string
      required:
        - round
        - netAmountCents
        - openedAt
        - evidence
      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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
    RoundEvidenceResponse:
      additionalProperties: false
      properties:
        amount:
          description: The launch value as declared or received.
          type: string
        declaredBy:
          description: The subject that declared it.
          type: string
        dtMovto:
          description: DtMovto of the launch.
          type: string
        effectiveAt:
          description: The launch's situation time (RFC3339).
          type: string
        messageCode:
          description: >-
            The STR message the proof is: LDL0022R1 for the deposit, LDL0006R2
            for its return.
          type: string
        numCtrlIF:
          description: NumCtrlIF of the client's LDL0022.
          type: string
        numCtrlSTR:
          description: >-
            NumCtrlSTR of the launch; omitted on a refusal, which launched
            nothing.
          type: string
        numCtrlSTROr:
          description: >-
            NumCtrlSTROr of an LDL0006R2: the NumCtrlSTR of the deposit it
            returned.
          type: string
        origin:
          description: CLIENT_DECLARED or BR_SPB.
          type: string
        recordedAt:
          description: When the rail recorded it (RFC3339).
          type: string
        refusal:
          $ref: '#/components/schemas/RoundRefusalResponse'
          description: >-
            What ended the LDL0022 with no STR launch (an LDL0022E, a GEN0004
            naming it, or Lerian SPB's close of it); omitted on a launch.
        sitLancCategory:
          description: EFFECTED, CANCELLED or REJECTED.
          type: string
        sitLancLDL:
          description: SitLancLDL as received.
          type: string
      required:
        - messageCode
        - effectiveAt
        - dtMovto
        - amount
        - origin
        - recordedAt
      type: object
    RoundRefusalResponse:
      additionalProperties: false
      properties:
        errorCode:
          description: >-
            CodErro or ErroGEN, verbatim; omitted when the E-return carried
            none.
          type: string
        messageCode:
          description: >-
            The refusal of the STR: the LDL0022 returned with its E code, or a
            GEN0004 naming it; omitted when Lerian SPB closed it.
          enum:
            - LDL0022E
            - GEN0004
          type: string
        railClose:
          description: >-
            Why Lerian SPB closed the LDL0022 with no answer of the STR: its
            grade closed or its movement day ended before any send reached the
            MQ, or two operators closed it past its deadline; omitted on a
            refusal of the STR.
          enum:
            - GRADE_CLOSED
            - DAY_ENDED
            - OPERATORS_CLOSED
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.