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

# Consultar cancelamento de agendamento de Pix Automático

> Consulta a situação viva do upstream de um cancelamento de agendamento, chaveada por (endToEndId, idCancelamento).



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml GET /v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}
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/{endToEndId}/cancel/{idCancelamento}:
    get:
      tags:
        - Pix Automático API
      summary: Consultar cancelamento de agendamento de Pix Automático
      description: >-
        Consulta a situação viva do upstream de um cancelamento de agendamento,
        chaveada por (endToEndId, idCancelamento).
      parameters:
        - description: O id da transação de pagamento (32 caracteres).
          in: path
          name: endToEndId
          required: true
          schema:
            description: O id da transação de pagamento (32 caracteres).
            type: string
        - description: O id do cancelamento (29 caracteres, CA...).
          in: path
          name: idCancelamento
          required: true
          schema:
            description: O id do cancelamento (29 caracteres, CA...).
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleCancellationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    ScheduleCancellationResponse:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 quando ausente).
          format: int64
          type: integer
        cancelledAt:
          description: Data/hora do cancelamento (UTC).
          type: string
        endToEndId:
          description: O id da transação de pagamento.
          type: string
        errorCode:
          description: Código de erro do upstream.
          type: string
        errorDesc:
          description: Descrição de erro do upstream.
          type: string
        idCancelamento:
          description: O id do cancelamento (CA...).
          type: string
        localStatus:
          description: ScheduleStatus local projetado a partir da situação do upstream.
          type: string
        localStatusKnown:
          description: >-
            False quando a situação do upstream não carrega status local
            projetado.
          type: boolean
        reason:
          description: motivoCancelamento (0..6).
          format: int64
          type: integer
        recipientIspb:
          description: ispbDestinatario (string).
          type: string
        reconciliationId:
          description: O id de conciliação do recebedor.
          type: string
        requestedAt:
          description: Data/hora da requisição upstream (UTC).
          type: string
        requester:
          description: solCancelamento (0=PSP pagador, 1=PSP recebedor).
          format: int64
          type: integer
        requesterDocument:
          description: CPF/CNPJ do solicitante (string).
          type: string
        requesterIspb:
          description: ispbSolicitante (string).
          type: string
        requesterType:
          description: tpPessoaSol.
          format: int64
          type: integer
        situationAt:
          description: Data/hora da situação (UTC).
          type: string
        stJdPi:
          description: Situação geral do upstream.
          format: int64
          type: integer
        stJdPiProc:
          description: Situação intermediária do upstream.
          format: int64
          type: integer
      required:
        - idCancelamento
        - endToEndId
        - stJdPiProc
        - stJdPi
        - localStatus
        - localStatusKnown
        - requester
        - requesterIspb
        - recipientIspb
        - requesterType
        - requesterDocument
        - reason
        - cancelStatus
      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).

````