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

# Request the regulatory cancellation of an operation

> Admits a NEW operation of type CANCELLATION targeting the path operation (the Núclea cancel request: ASLC060 for a credit, ASLC064 for a debit) from only the reason and an optional externalId. The new operation's creditor, domicile and settlement ISPBs, arrangement, value, currency, installments, due and transaction dates, participant and role are copied from the target; the merchant identity is not. Idempotent via the X-Idempotency header. An unknown target returns 404 OPERATION_NOT_FOUND; a target that is not a CREDIT or DEBIT returns 422 ORIGINAL_NOT_CANCELABLE_TYPE; one already cancelled, in settlement, settled or D+1 confirmed returns 409 OPERATION_NOT_CANCELABLE (ESLC0164); one Núclea has not accepted yet (no NUliquid) returns 409 ORIGINAL_NOT_ACCEPTED; one another cancellation already holds returns 409 DUPLICATE_CANCELLATION_TARGET; an externalId already in use returns 409 DUPLICATE_EXTERNAL_ID. To withdraw an operation that has not been transmitted (CREATED or QUEUED) use DELETE /v1/operations/{operationId} instead.



## OpenAPI

````yaml /es/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/cancellation
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/operations/{operationId}/cancellation:
    post:
      tags:
        - Operations
      summary: Request the regulatory cancellation of an operation
      description: >-
        Admits a NEW operation of type CANCELLATION targeting the path operation
        (the Núclea cancel request: ASLC060 for a credit, ASLC064 for a debit)
        from only the reason and an optional externalId. The new operation's
        creditor, domicile and settlement ISPBs, arrangement, value, currency,
        installments, due and transaction dates, participant and role are copied
        from the target; the merchant identity is not. Idempotent via the
        X-Idempotency header. An unknown target returns 404 OPERATION_NOT_FOUND;
        a target that is not a CREDIT or DEBIT returns 422
        ORIGINAL_NOT_CANCELABLE_TYPE; one already cancelled, in settlement,
        settled or D+1 confirmed returns 409 OPERATION_NOT_CANCELABLE
        (ESLC0164); one Núclea has not accepted yet (no NUliquid) returns 409
        ORIGINAL_NOT_ACCEPTED; one another cancellation already holds returns
        409 DUPLICATE_CANCELLATION_TARGET; an externalId already in use returns
        409 DUPLICATE_EXTERNAL_ID. To withdraw an operation that has not been
        transmitted (CREATED or QUEUED) use DELETE /v1/operations/{operationId}
        instead.
      operationId: requestOperationCancellation
      parameters:
        - description: Id (UUID) of the operation to cancel.
          in: path
          name: operationId
          required: true
          schema:
            description: Id (UUID) of the operation to cancel.
            examples:
              - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
            type: string
        - description: >-
            Idempotency key for safe retries; a replay returns the stored
            response.
          in: header
          name: X-Idempotency
          schema:
            description: >-
              Idempotency key for safe retries; a replay returns the stored
              response.
            type: string
        - description: Optional client request id echoed back in meta.requestId.
          in: header
          name: X-Request-Id
          schema:
            description: Optional client request id echoed back in meta.requestId.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCancellationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOperationResponse'
          description: Accepted
        '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:
    RequestCancellationRequest:
      additionalProperties: false
      properties:
        externalId:
          description: >-
            Optional client-side reference for the new CANCELLATION operation.
            When present it must not be used by any other operation (409
            DUPLICATE_EXTERNAL_ID).
          examples:
            - canc-2026-06-0001
          maxLength: 255
          type: string
        reasonCategory:
          description: 'Numeric MotvCanc cancellation reason (OP107 §11.3.16): ''1''..''4''.'
          enum:
            - '1'
            - '2'
            - '3'
            - '4'
          examples:
            - '4'
          type: string
      required:
        - reasonCategory
      type: object
    CreateOperationResponse:
      additionalProperties: false
      properties:
        externalId:
          description: Echoed client-side external identifier.
          examples:
            - acq-ext-2026-06-0001
          type: string
        id:
          description: Created operation id (UUID).
          examples:
            - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
          type: string
        meta:
          $ref: '#/components/schemas/CreateOperationMeta'
          description: Response envelope metadata (requestId + timestamp).
        state:
          description: Initial lifecycle state of the created operation.
          examples:
            - CREATED
          type: string
      required:
        - id
        - state
        - externalId
        - meta
      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
    CreateOperationMeta:
      additionalProperties: false
      properties:
        requestId:
          description: Client request id echoed back from the X-Request-Id header.
          examples:
            - req-2026-06-15-abc123
          type: string
        timestamp:
          description: Response generation timestamp (RFC3339).
          examples:
            - '2026-06-15T10:50:00Z'
          type: string
      required:
        - requestId
        - timestamp
      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.