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

# Registrar cancelamento de agendamento de Pix Automático de entrada

> Registra um desfecho de cancelamento de agendamento entregue pelo sistema upstream. Um cancelamento aceito (stCancelamento=0) transiciona o agendamento para Cancelled e remove logicamente a linha; um cancelamento rejeitado (stCancelamento=1) é reconhecido sem mudança de estado. Retorna o id local do gateway de liquidação.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules/inbound/cancellation/register
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  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: Registrar cancelamento de agendamento de Pix Automático de entrada
      description: >-
        Registra um desfecho de cancelamento de agendamento entregue pelo
        sistema upstream. Um cancelamento aceito (stCancelamento=0) transiciona
        o agendamento para Cancelled e remove logicamente a linha; um
        cancelamento rejeitado (stCancelamento=1) é reconhecido sem mudança de
        estado. Retorna o id local do gateway de liquidação.
      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: Erro
components:
  schemas:
    RegisterScheduleCancellationBody:
      additionalProperties: false
      properties:
        codigoErro:
          description: Código de erro do upstream (100 caracteres; em uma rejeição).
          type: string
        cpfCnpjSolCancelamento:
          description: CPF/CNPJ do solicitante (uma string v5.5.0).
          type: string
        descCodigoErro:
          description: Descrição de erro do upstream (100 caracteres).
          type: string
        dtHrCancelamento:
          description: Data/hora do cancelamento (UTC).
          type: string
        endToEndId:
          description: Id único de instrução de pagamento (32 caracteres).
          type: string
        idCancelamento:
          description: Id único de cancelamento (29 caracteres, CA...).
          type: string
        idConciliacaoRecebedor:
          description: Id de conciliação do recebedor (35 caracteres).
          type: string
        idRecorrencia:
          description: Id único de recorrência (29 caracteres, RR...).
          type: string
        ispbDestinatario:
          description: ISPB do PSP de destino (8 dígitos, uma string v5.5.0).
          type: string
        ispbSolicitante:
          description: ISPB do PSP solicitante (8 dígitos, uma string v5.5.0).
          type: string
        motivoCancelamento:
          description: Motivo do cancelamento (0..6).
          format: int64
          type: integer
        solCancelamento:
          description: PSP solicitante (0=pagador, 1=recebedor).
          format: int64
          type: integer
        stCancelamento:
          description: Status do cancelamento (0=Aceito, 1=Rejeitado).
          format: int64
          type: integer
        tpPessoaSol:
          description: Tipo de pessoa do solicitante (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: carimbo de data/hora de registro do gateway de liquidação (UTC).
          type: string
        idSgct:
          description: >-
            Id local de cancelamento do gateway de liquidação (GUID de 36
            caracteres).
          type: string
      required:
        - idSgct
        - dtHrSgct
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````