> ## 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 the client deposit acks recorded for a settlement instruction

> Lists the client settlement-deposit acks recorded against one settlement instruction, NEWEST FIRST, both SENT and FAILED, each with the failure reason the client gave. The response is PAGED (limit default 50, max 500) and pagination.hasNext says whether older acks remain, so a long history is never silently truncated. A client may legitimately send a FAILED then a SENT ack for one instruction (the FAILED does not change the instruction's state; the later SENT advances it), so both halves of that recovery sequence are returned. An unknown instruction id answers 404; a known instruction the client has not answered yet answers 200 with an empty list. RBAC: funding:read; tenant is always derived from the validated request identity, never the payload.



## OpenAPI

````yaml /es/openapi/v3-current/slc.yaml get /v1/funding/settlement-instructions/{instructionId}/acks
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://slc.sandbox.lerian.net
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 — hot-reloadable runtime configuration,
      dead-letter-queue inspection/replay, and outbox redispatch.
    name: Admin
paths:
  /v1/funding/settlement-instructions/{instructionId}/acks:
    get:
      tags:
        - Funding
      summary: List the client deposit acks recorded for a settlement instruction
      description: >-
        Lists the client settlement-deposit acks recorded against one settlement
        instruction, NEWEST FIRST, both SENT and FAILED, each with the failure
        reason the client gave. The response is PAGED (limit default 50, max
        500) and pagination.hasNext says whether older acks remain, so a long
        history is never silently truncated. A client may legitimately send a
        FAILED then a SENT ack for one instruction (the FAILED does not change
        the instruction's state; the later SENT advances it), so both halves of
        that recovery sequence are returned. An unknown instruction id answers
        404; a known instruction the client has not answered yet answers 200
        with an empty list. RBAC: funding:read; tenant is always derived from
        the validated request identity, never the payload.
      operationId: listSettlementInstructionAcks
      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
        - description: >-
            Page size (default 50, max 500). A non-positive/non-numeric value is
            rejected with 400.
          explode: false
          in: query
          name: limit
          schema:
            description: >-
              Page size (default 50, max 500). A non-positive/non-numeric value
              is rejected with 400.
            examples:
              - '50'
            type: string
        - description: >-
            Row offset (default 0). A negative/non-numeric value is rejected
            with 400.
          explode: false
          in: query
          name: offset
          schema:
            description: >-
              Row offset (default 0). A negative/non-numeric value is rejected
              with 400.
            examples:
              - '0'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstructionAcksResponse'
          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:
    ListInstructionAcksResponse:
      additionalProperties: false
      properties:
        instructionId:
          description: The settlement instruction these acks belong to.
          type: string
        items:
          description: >-
            This page of the instruction's recorded acks, NEWEST FIRST, both
            SENT and FAILED — so a FAILED-then-SENT recovery reads as the
            sequence it is.
          items:
            $ref: '#/components/schemas/FundingAckResponse'
          type: array
        pagination:
          $ref: '#/components/schemas/AckPaginationMeta'
          description: >-
            Pagination metadata for this page. An instruction normally holds a
            handful of acks, but the count is client-controlled, so the page is
            explicit and hasNext says whether older acks remain.
      required:
        - instructionId
        - 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
    FundingAckResponse:
      additionalProperties: false
      properties:
        ackedAt:
          description: >-
            When the client said it acked (RFC3339). Omitted when the client
            sent none.
          type: string
        amountCents:
          description: The amount the client reported, in cents, echoed back unchanged.
          format: int64
          type: integer
        errorDetail:
          description: >-
            The failure reason the client gave for a FAILED result, verbatim.
            Omitted when the client gave none.
          type: string
        id:
          description: The recorded ack's id.
          type: string
        instructionId:
          description: The settlement instruction the ack was recorded against.
          type: string
        ldl0022Ref:
          description: >-
            The client's own reference to its LDL0022 (IF->STR), outside the
            SLC. Omitted when the client sent none.
          type: string
        recordedAt:
          description: When the SLC recorded the ack (RFC3339). This is the ordering key.
          type: string
        result:
          description: >-
            The result the client reported: SENT (deposited) or FAILED (could
            not).
          type: string
      required:
        - id
        - instructionId
        - result
        - amountCents
        - recordedAt
      type: object
    AckPaginationMeta:
      additionalProperties: false
      properties:
        hasNext:
          description: >-
            True when the returned page filled the requested limit (page-full
            heuristic; no total count).
          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

````