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

# Cancelar una programación de Pix Automático

> Cancela una instrucción de pago programada, transicionándola a Cancelled y eliminando de forma lógica el registro local. Devuelve el id de cancelación (idCancelamento).



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules/{endToEndId}/cancel
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:
    post:
      tags:
        - Pix Automático API
      summary: Cancelar una programación de Pix Automático
      description: >-
        Cancela una instrucción de pago programada, transicionándola a Cancelled
        y eliminando de forma lógica el registro local. Devuelve el id de
        cancelación (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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelScheduleBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelScheduleResponse'
          description: Aceptado
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    CancelScheduleBody:
      additionalProperties: false
      properties:
        reason:
          description: motivoCancelamento (0..6).
          format: int64
          type: integer
        recipientIspb:
          description: ISPB del participante de destino (ispbDestinatario, cadena).
          type: string
        reconciliationId:
          description: Id de conciliación del receptor (idConciliacaoRecebedor).
          type: string
        requester:
          description: solCancelamento (0=PSP pagador, 1=PSP recebedor).
          format: int64
          type: integer
        requesterDocument:
          description: CPF/CNPJ del solicitante (cpfCnpjSolCancelamento, cadena).
          type: string
        requesterIspb:
          description: ISPB del participante solicitante (ispbSolicitante, cadena).
          type: string
        requesterPersonType:
          description: tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - requester
        - requesterIspb
        - recipientIspb
        - reconciliationId
        - requesterPersonType
        - requesterDocument
        - reason
      type: object
    CancelScheduleResponse:
      additionalProperties: false
      properties:
        cancelledAt:
          description: Marca de tiempo de la cancelación (dtHrCancelamento, UTC).
          type: string
        endToEndId:
          description: El id de la transacción de pago (reflejado).
          type: string
        idCancelamento:
          description: El id de cancelación (29 caracteres, CA...).
          type: string
        reconciliationId:
          description: El id de conciliación del receptor (reflejado).
          type: string
        status:
          description: El estado local resultante de la programación.
          type: string
      required:
        - endToEndId
        - reconciliationId
        - idCancelamento
        - cancelledAt
        - status
      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).

````