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

# Confirm or refuse received settlements

> Gives this IF Domicílio's answer to settlements Núclea notified it of. Each item is decided on its own and reported with its own status; the batch answers 200. A credit paid after today is answered in its pre-scheduling phase (01 on confirm), any settlement paid today in its settlement phase (00 on confirm); a refusal carries one OP107 §11.3.3 code. A CONFIRM for a cancelled settlement is accepted only to send its cancellation confirmation (34) again, unless a refusal of that settlement is still live; a 34 still live answers 409, and a refusal is refused with the cancelled-settlement error. Stored answers go to Núclea in an ASLC023 (credit), ASLC025 (debit) or ASLC033 (anticipation) file, and a resent 34 in an ASLC062 or ASLC066 file in the phase's next window; Núclea's verdict reaches GET /v1/domicile/settlements and the domicile.response_accepted / domicile.response_rejected events. RBAC: domicile:write.



## OpenAPI

````yaml /pt/openapi/v3-current/slc.yaml post /v1/domicile/responses
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/responses:
    post:
      tags:
        - Domicile
      summary: Confirm or refuse received settlements
      description: >-
        Gives this IF Domicílio's answer to settlements Núclea notified it of.
        Each item is decided on its own and reported with its own status; the
        batch answers 200. A credit paid after today is answered in its
        pre-scheduling phase (01 on confirm), any settlement paid today in its
        settlement phase (00 on confirm); a refusal carries one OP107 §11.3.3
        code. A CONFIRM for a cancelled settlement is accepted only to send its
        cancellation confirmation (34) again, unless a refusal of that
        settlement is still live; a 34 still live answers 409, and a refusal is
        refused with the cancelled-settlement error. Stored answers go to Núclea
        in an ASLC023 (credit), ASLC025 (debit) or ASLC033 (anticipation) file,
        and a resent 34 in an ASLC062 or ASLC066 file in the phase's next
        window; Núclea's verdict reaches GET /v1/domicile/settlements and the
        domicile.response_accepted / domicile.response_rejected events. RBAC:
        domicile:write.
      operationId: respondDomicileSettlements
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnswersRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnswersResponse'
          description: OK
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Request Entity Too Large
        '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:
    AnswersRequest:
      additionalProperties: false
      properties:
        items:
          description: 1 to 1,000 answers, each decided on its own.
          items:
            $ref: '#/components/schemas/AnswerItem'
          maxItems: 1000
          minItems: 1
          type:
            - array
            - 'null'
      required:
        - items
      type: object
    AnswersResponse:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AnswerResult'
          type: array
      required:
        - items
      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
    AnswerItem:
      additionalProperties: false
      properties:
        decision:
          description: >-
            CONFIRM sends 01 before the payment date (credit pre-scheduling) and
            00 on it; REFUSE sends reasonCode.
          enum:
            - CONFIRM
            - REFUSE
          type: string
        nuLiquid:
          description: The Núclea settlement number (NULiquid) of a received settlement.
          examples:
            - '202605280000000000001'
          maxLength: 21
          minLength: 21
          type: string
        reasonCode:
          description: >-
            Required with REFUSE, absent with CONFIRM: one OP107 §11.3.3 refusal
            code (02-12, 30-33 or 99).
          examples:
            - '11'
          pattern: ^[0-9]{2}$
          type: string
      required:
        - nuLiquid
        - decision
      type: object
    AnswerResult:
      additionalProperties: false
      properties:
        error:
          description: Why the item was not stored.
          type: string
        nuLiquid:
          description: The item's NULiquid.
          type: string
        responseId:
          description: The stored answer's id (201 only).
          format: uuid
          type: string
        status:
          description: >-
            201 stored and sent in the phase's next window; 404 no notice
            carried this NULiquid; 409 the phase already has a live answer; 422
            a code rule refuses it, the phase's last window of the day closed,
            or an ASLC061/065 cancelled the settlement.
          enum:
            - 201
            - 404
            - 409
            - 422
          format: int64
          type: integer
      required:
        - nuLiquid
        - status
      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.