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

> Returns the full detail of one settlement operation, including its recorded eslcErrors and recoverability diagnostics.



## OpenAPI

````yaml en/openapi/v3-current/slc.yaml get /v1/operations/{operationId}
openapi: 3.1.0
info:
  description: >-
    API for Lerian SLC — the participant-side rail that connects the institution
    to Núclea's SLC deferred-net card settlement. It covers settlement-operation
    intake and lifecycle, clearing positions, the participant and arrangement
    registry, generated reports, embedded XSD schema introspection, transmission
    recovery and connectivity to Núclea, BYOK Model-A signing-key import, and
    tenant-scoped webhooks.
  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/SILOC (the private card
      clearing house that operates the SILOC settlement system) — 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 A1 (Brazilian PKI server
      certificate, 1-year validity) certificate material used to sign ASLC
      files; the private key never leaves the client's HSM/KMS/Vault.
    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 (Midaz, client ledgers, Cabine — all optional).
    name: Webhooks
  - description: >-
      Administrative operations — hot-reloadable runtime configuration,
      dead-letter-queue inspection/replay, and outbox redispatch.
    name: Admin
paths:
  /v1/operations/{operationId}:
    get:
      tags:
        - Operations
      summary: Get a settlement operation
      description: >-
        Returns the full detail of one settlement operation, including its
        recorded eslcErrors and recoverability diagnostics.
      operationId: getOperation
      parameters:
        - description: Settlement operation id (UUID).
          in: path
          name: operationId
          required: true
          schema:
            description: Settlement operation id (UUID).
            examples:
              - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationDetailResponse'
          description: OK
        '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:
    OperationDetailResponse:
      additionalProperties: false
      properties:
        arrangementCode:
          description: Payment arrangement (arranjo) code.
          examples:
            - '0245'
          type: string
        aslcType:
          description: ASLC message type materialized for this operation.
          examples:
            - ASLC027
          type: string
        batchId:
          description: Batch id when created via the NDJSON batch endpoint.
          examples:
            - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
          type: string
        cancellationTargetOperationId:
          description: >-
            Id (UUID) of the operation a CANCELLATION targets; null for every
            other type.
          examples:
            - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
          type:
            - string
            - 'null'
        createdAt:
          description: Creation timestamp (RFC3339).
          examples:
            - '2026-06-15T10:50:00Z'
          type: string
        creditorIspb:
          description: Creditor (acquirer) ISPB, 8 digits.
          examples:
            - '29011780'
          type: string
        currency:
          description: ISO 4217 currency code.
          examples:
            - BRL
          type: string
        domicileIfIspb:
          description: Domicile FI ISPB (bank where the merchant receives funds), 8 digits.
          examples:
            - '60701190'
          type: string
        dueDate:
          description: Settlement due date (RFC3339); null when not set.
          examples:
            - '2026-06-15T00:00:00Z'
          type:
            - string
            - 'null'
        eslcErrors:
          description: Recorded Núclea business error codes (empty array when none).
          items:
            type: string
          type:
            - array
            - 'null'
        externalId:
          description: Client-side external identifier.
          examples:
            - acq-ext-2026-06-0001
          type: string
        id:
          description: Operation id (UUID).
          examples:
            - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
          type: string
        installmentNumber:
          description: This installment's sequence number.
          examples:
            - 1
          format: int32
          type: integer
        installments:
          description: Total number of installments.
          examples:
            - 3
          format: int32
          type: integer
        intakeMode:
          description: Intake mode the operation was received through.
          examples:
            - api_jsonl
          type: string
        lastError:
          description: Most recent recorded Núclea business error code; null when none.
          examples:
            - ESLC0029
          type:
            - string
            - 'null'
        nuliquid:
          description: Núclea-assigned NUliquid (21 positions); null until assigned.
          examples:
            - '202606150000000000001'
          type:
            - string
            - 'null'
        operationType:
          description: Operation type.
          examples:
            - CREDIT
          type: string
        participantId:
          description: Owning participant id (UUID).
          examples:
            - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
          type: string
        participantRole:
          description: Participant role in the settlement.
          examples:
            - ACQUIRER
          type: string
        reasonCategory:
          description: >-
            Numeric MotvCanc cancellation reason ('1'..'4'); null unless a
            CANCELLATION.
          examples:
            - '4'
          type:
            - string
            - 'null'
        settlementIfIspb:
          description: Settlement FI ISPB, 8 digits; null when not set.
          examples:
            - '60746948'
          type:
            - string
            - 'null'
        state:
          description: Lifecycle state.
          examples:
            - SETTLED
          type: string
        stuckSince:
          description: >-
            Timestamp since the operation has been internally stuck (RFC3339);
            null when not stuck.
          examples:
            - '2026-06-15T11:00:00Z'
          type:
            - string
            - 'null'
        transactionDate:
          description: Business transaction date (RFC3339).
          examples:
            - '2026-06-15T00:00:00Z'
          type: string
        updatedAt:
          description: Last-update timestamp (RFC3339).
          examples:
            - '2026-06-15T13:10:00Z'
          type: string
        value:
          description: Operation amount in minor units (centavos).
          examples:
            - 150000
          format: int64
          type: integer
        waitingFor:
          description: >-
            What the operation is waiting on, and therefore which recovery verb
            applies. transport/nuclea_ack/if_confirmation are external waits
            (reconcile or wait). parked means an outbound transmit claim is held
            because the attempt budget was exhausted and nothing reached Núclea:
            recover with POST /v1/connectivity/unpark. in_flight means the file
            IS at Núclea and the local transition failed: reconcile with Núclea,
            then POST /v1/operations/{operationId}/advance, and NEVER un-park
            it. null names NO verb: it means no external dependency is named for
            this state — the operation is terminal, or the wait is internal
            (CREATED/ACCEPTED, where advance/requeue applies), or it awaits a
            counterpart this vocabulary does not name yet (CONFIRMED awaits the
            funding ack plus the Núclea cycle close; SETTLED awaits the D+1
            return file). Pair a null with state before choosing an action.
          enum:
            - transport
            - nuclea_ack
            - if_confirmation
            - parked
            - in_flight
            - null
          examples:
            - nuclea_ack
          type:
            - string
            - 'null'
      required:
        - id
        - externalId
        - operationType
        - state
        - participantId
        - participantRole
        - settlementIfIspb
        - value
        - currency
        - installments
        - installmentNumber
        - dueDate
        - transactionDate
        - nuliquid
        - intakeMode
        - eslcErrors
        - reasonCategory
        - cancellationTargetOperationId
        - createdAt
        - updatedAt
        - waitingFor
        - stuckSince
        - lastError
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````