> ## 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 una cancelación de programación de Pix Automático

> Consulta la situación en vivo del upstream de una cancelación de programación, indexada por (endToEndId, idCancelamento).



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml GET /v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  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 una cancelación de programación de Pix Automático
      description: >-
        Consulta la situación en vivo del upstream de una cancelación de
        programación, indexada por (endToEndId, idCancelamento).
      parameters:
        - description: The payment-transaction id (32-char).
          in: path
          name: endToEndId
          required: true
          schema:
            description: El id de la transacción de pago (32 caracteres).
            type: string
        - description: The cancellation id (29-char, CA...).
          in: path
          name: idCancelamento
          required: true
          schema:
            description: El id de cancelación (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: Error
components:
  schemas:
    ScheduleCancellationResponse:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 cuando está ausente).
          format: int64
          type: integer
        cancelledAt:
          description: Marca de tiempo de la cancelación (UTC).
          type: string
        endToEndId:
          description: El id de la transacción de pago.
          type: string
        errorCode:
          description: Código de error del upstream.
          type: string
        errorDesc:
          description: Descripción del error del upstream.
          type: string
        idCancelamento:
          description: El id de cancelación (CA...).
          type: string
        localStatus:
          description: ScheduleStatus local proyectado desde la situación del upstream.
          type: string
        localStatusKnown:
          description: >-
            False cuando la situación del upstream no lleva ningún estado local
            proyectado.
          type: boolean
        reason:
          description: motivoCancelamento (0..6).
          format: int64
          type: integer
        recipientIspb:
          description: ispbDestinatario (cadena).
          type: string
        reconciliationId:
          description: El id de conciliación del receptor.
          type: string
        requestedAt:
          description: Marca de tiempo de la solicitud en el upstream (UTC).
          type: string
        requester:
          description: solCancelamento (0=PSP pagador, 1=PSP recebedor).
          format: int64
          type: integer
        requesterDocument:
          description: CPF/CNPJ del solicitante (cadena).
          type: string
        requesterIspb:
          description: ispbSolicitante (cadena).
          type: string
        requesterType:
          description: tpPessoaSol.
          format: int64
          type: integer
        situationAt:
          description: Marca de tiempo de la situación (UTC).
          type: string
        stJdPi:
          description: Situación general del upstream.
          format: int64
          type: integer
        stJdPiProc:
          description: Situación intermedia del 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 error de dominio estable y legible por máquina, acotado al
            servicio emisor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            Una explicación legible para humanos específica de esta ocurrencia
            del problema.
          type: string
        errors:
          description: Lista opcional de detalles de error individuales
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Una referencia URI que identifica la ocurrencia específica del
            problema.
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          format: int64
          type: integer
        title:
          description: >-
            Un resumen breve y legible para humanos del tipo de problema. Este
            valor no debería cambiar entre ocurrencias del error.
          type: string
        type:
          default: about:blank
          description: >-
            Una referencia URI a la documentación legible para humanos del
            error.
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Dónde ocurrió el error, p. ej. 'body.items[3].tags' o
            'path.thing-id'
          type: string
        message:
          description: Texto del mensaje de error
          type: string
        value:
          description: El valor en la ubicación indicada
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````