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

# Read one settlement by NULiquid

> Reads one settlement by its NULiquid, as the notice carried it. An unknown NULiquid answers 404. RBAC: domicile:read.



## OpenAPI

````yaml /pt/openapi/v3-current/slc.yaml get /v1/domicile/settlements/{nuLiquid}
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/domicile/settlements/{nuLiquid}:
    get:
      tags:
        - Domicile
      summary: Read one settlement by NULiquid
      description: >-
        Reads one settlement by its NULiquid, as the notice carried it. An
        unknown NULiquid answers 404. RBAC: domicile:read.
      operationId: getDomicileSettlement
      parameters:
        - description: The Núclea settlement number (NULiquid).
          in: path
          name: nuLiquid
          required: true
          schema:
            description: The Núclea settlement number (NULiquid).
            examples:
              - '202605280000000000001'
            maxLength: 21
            minLength: 21
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementResponse'
          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:
    SettlementResponse:
      additionalProperties: false
      properties:
        acquirerAccount:
          description: CtCreddr; absent when the file omits it.
          type: string
        acquirerBranch:
          description: AgCreddr; absent when the file omits it.
          type: string
        acquirerCnpj:
          description: CNPJCreddr.
          type: string
        acquirerCnpjBase:
          description: CNPJBaseCreddr.
          type: string
        acquirerName:
          description: NomCreddr.
          type: string
        administeredParticipant:
          description: IdentdPartAdmtd.
          type: string
        amount:
          description: VlrPgto, verbatim, as a decimal string.
          type: string
        amountType:
          description: TpVlrPgto.
          type: string
        arrangementCode:
          description: CodInstitdrArrajPgto.
          type: string
        cancelled:
          $ref: '#/components/schemas/CancelledResponse'
          description: >-
            The ASLC061/065 that cancelled the settlement: the domicile must not
            credit it. Absent while it stands.
        centralizerAccount:
          description: CtCentrlz; absent when the file omits it.
          type: string
        centralizerAccountType:
          description: TpCt; absent when the file omits it.
          type: string
        centralizerBranch:
          description: AgCentrlz; absent when the file omits it.
          type: string
        centralizerCode:
          description: CodCentrlz.
          type: string
        centralizerDocument:
          description: CNPJ_CPFCentrlz.
          type: string
        centralizerPaymentAccount:
          description: CtPgtoCentrlz; absent when the file omits it.
          type: string
        centralizerPersonType:
          description: TpPessoaCentrlz.
          type: string
        currency:
          description: CodMoeda.
          type: string
        fileControlNumber:
          description: NumCtrlEmis of the file.
          type: string
        fileName:
          description: NomArq of the file.
          type: string
        ispbIfCreditor:
          description: ISPBIFCredr.
          type: string
        ispbIfDebtor:
          description: ISPBIFDevdr.
          type: string
        ispbIfSettlement:
          description: ISPBIFLiquidPontoVenda.
          type: string
        maintainedAt:
          description: DtHrManut, verbatim.
          type: string
        nuLiquid:
          description: NULiquid, the Núclea settlement number.
          type: string
        paymentDate:
          description: DtPgto (YYYY-MM-DD).
          type: string
        posCode:
          description: CodPontoVenda.
          type: string
        posDocument:
          description: CNPJ_CPFPontoVenda.
          type: string
        posName:
          description: NomePontoVenda.
          type: string
        posPersonType:
          description: TpPessoaPontoVenda.
          type: string
        posType:
          description: TpPontoVenda.
          type: string
        principalParticipant:
          description: IdentdPartPrincipal.
          type: string
        productType:
          description: TpProdLiquidCred, TpProdLiquidDeb or TpProdLiquidCarts, by type.
          type: string
        receivedAt:
          description: When this rail stored the settlement (RFC3339).
          type: string
        referenceDate:
          description: DtRef of the file (YYYY-MM-DD).
          type: string
        responses:
          description: >-
            The answers given to this settlement, oldest first; empty until one
            is given.
          items:
            $ref: '#/components/schemas/AnswerResponse'
          type: array
        settled:
          $ref: '#/components/schemas/SettledResponse'
          description: >-
            Núclea's ASLC929 report that read the settlement Liquidado; absent
            while open.
        strProofs:
          description: >-
            The STR's proof that an LBTR paid this ASLC032 settlement's file,
            from the SLC0005 and LTR0005R2 this rail stored; empty until both
            arrive and agree, and always empty for CREDIT and DEBIT.
          items:
            $ref: '#/components/schemas/STRProofResponse'
          type: array
        transferForm:
          description: IndrFormaTransf.
          type: string
        type:
          description: >-
            The notice that carried it: CREDIT (ASLC022), DEBIT (ASLC024),
            ANTICIPATION (ASLC032).
          enum:
            - CREDIT
            - DEBIT
            - ANTICIPATION
          type: string
      required:
        - nuLiquid
        - type
        - fileName
        - fileControlNumber
        - referenceDate
        - principalParticipant
        - administeredParticipant
        - acquirerCnpjBase
        - acquirerCnpj
        - acquirerName
        - ispbIfDebtor
        - ispbIfCreditor
        - centralizerPersonType
        - centralizerDocument
        - centralizerCode
        - ispbIfSettlement
        - posCode
        - posName
        - posPersonType
        - posDocument
        - arrangementCode
        - productType
        - transferForm
        - currency
        - posType
        - amountType
        - paymentDate
        - amount
        - maintainedAt
        - receivedAt
        - responses
        - strProofs
      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
    CancelledResponse:
      additionalProperties: false
      properties:
        cancelledAt:
          description: When this rail stored the notice (RFC3339).
          type: string
        fileName:
          description: NomArq of the ASLC061 (credit) or ASLC065 (debit).
          type: string
        maintainedAt:
          description: DtHrManut of the notice, verbatim.
          type: string
        reason:
          description: MotvCanc of the notice, verbatim (OP107 §11.3.16).
          type: string
      required:
        - cancelledAt
        - fileName
        - reason
        - maintainedAt
      type: object
    AnswerResponse:
      additionalProperties: false
      properties:
        controlNumberCip:
          description: NumCtrlCIPActo of an accepted answer.
          type: string
        createdAt:
          description: When the answer was given (RFC3339).
          type: string
        decision:
          description: The client's decision.
          enum:
            - CONFIRM
            - REFUSE
          type: string
        fileName:
          description: NomArq of the file carrying the answer, once named.
          type: string
        occurrenceCode:
          description: >-
            CodOcorc sent: 01 (pre-scheduling confirmed), 00 (settlement
            confirmed), 34 (cancellation confirmed) or the refusal code.
          type: string
        phase:
          description: >-
            SCHEDULING: a credit's pre-scheduling answer, up to D-1. SETTLEMENT:
            the answer on the payment date. CANCEL: the confirmation (34) of an
            ASLC061/065 cancellation, sent without an operator; after Núclea
            rejects it, POST /v1/domicile/responses with CONFIRM sends it again.
          enum:
            - SCHEDULING
            - SETTLEMENT
            - CANCEL
          type: string
        rejectionCodes:
          description: ESLC/EGEN codes of a rejected answer.
          items:
            type: string
          type:
            - array
            - 'null'
        responseId:
          description: The answer's id.
          format: uuid
          type: string
        state:
          description: >-
            PENDING waits for its window; SENDING and SENT are with the
            transport; PARKED is a send that may have reached Núclea and waits
            for the operator; ACCEPTED and REJECTED are Núclea's verdict.
          enum:
            - PENDING
            - SENDING
            - SENT
            - PARKED
            - ACCEPTED
            - REJECTED
          type: string
        updatedAt:
          description: When its state last moved (RFC3339).
          type: string
      required:
        - responseId
        - phase
        - decision
        - occurrenceCode
        - state
        - createdAt
        - updatedAt
      type: object
    SettledResponse:
      additionalProperties: false
      properties:
        domicileStatus:
          description: SitRespDomicilio of that report's record, verbatim.
          type: string
        reportControlNumber:
          description: NumCtrlRelat of that report, verbatim.
          type: string
        settledAt:
          description: When this rail read SitSolictLiquidacao Liquidado (RFC3339).
          type: string
      required:
        - settledAt
        - reportControlNumber
        - domicileStatus
      type: object
    STRProofResponse:
      additionalProperties: false
      properties:
        amount:
          description: VlrLanc of the LTR0005R2, verbatim, as a decimal string.
          type: string
        numCtrlLtr:
          description: NumCtrlLTR of the LTR0005R2.
          type: string
        numCtrlSlc:
          description: NumCtrlSLC of the SLC0005 that names the file and the transfer.
          type: string
        numCtrlStr:
          description: NumCtrlSTR of the LTR0005R2.
          type: string
        settledAt:
          description: When the STR settled the transfer (the LTR0005R2's DtHrBC, RFC3339).
          type: string
      required:
        - numCtrlSlc
        - numCtrlStr
        - numCtrlLtr
        - settledAt
        - amount
      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.