> ## 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 settlement instructions

> Lists the card settlement instructions, newest business day first, filtered by business day, cycle and state, paged. Amounts are the values the LDL0021 carried. RBAC: funding:read.



## OpenAPI

````yaml /pt/openapi/v3-current/slc.yaml get /v1/funding/settlement-instructions
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:
    get:
      tags:
        - Funding
      summary: List settlement instructions
      description: >-
        Lists the card settlement instructions, newest business day first,
        filtered by business day, cycle and state, paged. Amounts are the values
        the LDL0021 carried. RBAC: funding:read.
      operationId: listSettlementInstructions
      parameters:
        - description: Settlement business day (YYYY-MM-DD).
          explode: false
          in: query
          name: referenceDate
          schema:
            description: Settlement business day (YYYY-MM-DD).
            examples:
              - '2026-06-28'
            type: string
        - description: CodPerOperac of the deposit cycle.
          explode: false
          in: query
          name: cycle
          schema:
            description: CodPerOperac of the deposit cycle.
            examples:
              - '1'
            type: string
        - description: PENDING, NOTIFIED, DEPOSITED or SETTLED.
          explode: false
          in: query
          name: state
          schema:
            description: PENDING, NOTIFIED, DEPOSITED or SETTLED.
            examples:
              - NOTIFIED
            type: string
        - description: Page size (default 50, max 500).
          explode: false
          in: query
          name: limit
          schema:
            description: Page size (default 50, max 500).
            examples:
              - '50'
            type: string
        - description: Row offset (default 0).
          explode: false
          in: query
          name: offset
          schema:
            description: Row offset (default 0).
            examples:
              - '0'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstructionsResponse'
          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:
    ListInstructionsResponse:
      additionalProperties: false
      properties:
        items:
          description: This page of instructions.
          items:
            $ref: '#/components/schemas/SettlementInstructionResponse'
          type: array
        pagination:
          $ref: '#/components/schemas/InstructionPagination'
          description: Pagination metadata.
      required:
        - items
        - pagination
      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
    SettlementInstructionResponse:
      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
        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
        state:
          description: PENDING, NOTIFIED, DEPOSITED or SETTLED.
          type: string
        updatedAt:
          description: Last change (RFC3339).
          type: string
      required:
        - id
        - referenceDate
        - cycle
        - state
        - round
        - netAmountCents
        - currency
        - updatedAt
      type: object
    InstructionPagination:
      additionalProperties: false
      properties:
        hasNext:
          description: True when the page filled the requested limit.
          examples:
            - false
          type: boolean
        page:
          description: 1-based page number derived from the offset.
          examples:
            - 1
          format: int64
          type: integer
        perPage:
          description: Requested page size.
          examples:
            - 50
          format: int64
          type: integer
      required:
        - page
        - perPage
        - hasNext
      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
  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.