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

# Register an inbound Pix Automático schedule cancellation

> Registers a schedule cancellation outcome delivered by the upstream system. An accepted cancellation (stCancelamento=0) transitions the schedule to Cancelled and soft-deletes the row; a rejected cancellation (stCancelamento=1) is acknowledged with no state change. Returns the local settlement-gateway id.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules/inbound/cancellation/register
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/pix-automatico/schedules/inbound/cancellation/register:
    post:
      tags:
        - Pix Automático API
      summary: Register an inbound Pix Automático schedule cancellation
      description: >-
        Registers a schedule cancellation outcome delivered by the upstream
        system. An accepted cancellation (stCancelamento=0) transitions the
        schedule to Cancelled and soft-deletes the row; a rejected cancellation
        (stCancelamento=1) is acknowledged with no state change. Returns the
        local settlement-gateway id.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterScheduleCancellationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterScheduleCancellationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RegisterScheduleCancellationBody:
      additionalProperties: false
      properties:
        codigoErro:
          description: Upstream error code (100-char; on a rejection).
          type: string
        cpfCnpjSolCancelamento:
          description: Requester CPF/CNPJ (a v5.5.0 string).
          type: string
        descCodigoErro:
          description: Upstream error description (100-char).
          type: string
        dtHrCancelamento:
          description: Cancellation timestamp (UTC).
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char).
          type: string
        idCancelamento:
          description: Unique cancellation id (29-char, CA...).
          type: string
        idConciliacaoRecebedor:
          description: Receiver conciliation id (35-char).
          type: string
        idRecorrencia:
          description: Unique recurrence id (29-char, RR...).
          type: string
        ispbDestinatario:
          description: Destination PSP ISPB (8 digits, a v5.5.0 string).
          type: string
        ispbSolicitante:
          description: Requesting PSP ISPB (8 digits, a v5.5.0 string).
          type: string
        motivoCancelamento:
          description: Cancellation reason (0..6).
          format: int64
          type: integer
        solCancelamento:
          description: Requesting PSP (0=pagador, 1=recebedor).
          format: int64
          type: integer
        stCancelamento:
          description: Cancellation status (0=Aceito, 1=Rejeitado).
          format: int64
          type: integer
        tpPessoaSol:
          description: Requester person type (0=PF, 1=PJ).
          format: int64
          type: integer
      required:
        - idCancelamento
        - idRecorrencia
        - stCancelamento
        - solCancelamento
        - ispbSolicitante
        - ispbDestinatario
        - idConciliacaoRecebedor
        - tpPessoaSol
        - cpfCnpjSolCancelamento
        - motivoCancelamento
        - endToEndId
        - dtHrCancelamento
      type: object
    RegisterScheduleCancellationResponse:
      additionalProperties: false
      properties:
        dtHrSgct:
          description: settlement-gateway registration timestamp (UTC).
          type: string
        idSgct:
          description: Local settlement-gateway cancellation id (36-char GUID).
          type: string
      required:
        - idSgct
        - dtHrSgct
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          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:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````