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

# Validar una cancelación entrante de Pix Automático

> Valida una solicitud entrante de cancelación de pago recurrente enviada por el sistema upstream. La cancelación es válida solo cuando existe una autorización activa y su estado actual permite la cancelación; el resultado se devuelve en línea (200).



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/authorizations/inbound/cancellation/validate
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/authorizations/inbound/cancellation/validate:
    post:
      tags:
        - Pix Automático API
      summary: Validar una cancelación entrante de Pix Automático
      description: >-
        Valida una solicitud entrante de cancelación de pago recurrente enviada
        por el sistema upstream. La cancelación es válida solo cuando existe una
        autorización activa y su estado actual permite la cancelación; el
        resultado se devuelve en línea (200).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateCancellationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateCancellationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ValidateCancellationBody:
      additionalProperties: false
      properties:
        cpfCnpjSolCancelamento:
          description: CPF/CNPJ del solicitante (una cadena v5.5.0).
          type: string
        descContrato:
          description: Descripción de contrato de texto libre (35 caracteres).
          type: string
        devedor:
          $ref: '#/components/schemas/InboundDebtorBlock'
        dtFinalRecorrencia:
          description: Fecha del último pago (aaaa-mm-dd).
          type: string
        dtHrCancelamento:
          description: Marca de tiempo de la cancelación (UTC).
          type: string
        dtHrCriacaoRecorrencia:
          description: Marca de tiempo de creación de la recurrencia (UTC).
          type: string
        dtInicialRecorrencia:
          description: Fecha del primer pago (aaaa-mm-dd).
          type: string
        idCancelamento:
          description: Id de cancelación único (29 caracteres, IC...).
          type: string
        idRecorrencia:
          description: Id de recurrencia único (29 caracteres, RR...).
          type: string
        motivoCancelamento:
          description: Motivo de cancelación (0..10).
          format: int64
          type: integer
        nrContrato:
          description: Identificador de contrato/orden (35 caracteres).
          type: string
        pagador:
          $ref: '#/components/schemas/InboundPayerBlock'
        recebedor:
          $ref: '#/components/schemas/InboundRecipientBlock'
        tpFrequencia:
          description: Periodicidad de la recurrencia (0..4).
          format: int64
          type: integer
        tpPessoaSol:
          description: Tipo de persona del solicitante (0=PF, 1=PJ).
          format: int64
          type: integer
        valor:
          description: Monto fijo del pago en reales (un número JSON).
          format: double
          type: number
      required:
        - idRecorrencia
        - idCancelamento
        - tpPessoaSol
        - cpfCnpjSolCancelamento
        - motivoCancelamento
        - tpFrequencia
        - dtInicialRecorrencia
        - recebedor
        - pagador
        - nrContrato
      type: object
    ValidateCancellationResponse:
      additionalProperties: false
      properties:
        dtHrValidacao:
          description: Marca de tiempo de la validación (UTC).
          type: string
        motivoRejeicao:
          description: Código de motivo de rechazo (obligatorio cuando resultado=0).
          type: string
        resultado:
          description: Resultado de la validación (0=Invalido, 1=Valido).
          format: int64
          type: integer
      required:
        - resultado
        - dtHrValidacao
      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
    InboundDebtorBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF o CNPJ del deudor (una cadena v5.5.0).
          type: string
        nome:
          description: Nombre/razão social del deudor.
          type: string
        tpPessoa:
          description: Tipo de persona (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - tpPessoa
        - cpfCnpj
        - nome
      type: object
    InboundPayerBlock:
      additionalProperties: false
      properties:
        codMunIbge:
          description: >-
            Código IBGE del municipio del pagador (7 dígitos). Se transporta por
            completitud del mensaje; la especificación lo marca como Sim en
            5.2.4, pero el servicio no consume ni persiste el municipio del
            pagador en esta oleada (el dominio no tiene campo de municipio).
          format: int64
          type: integer
        cpfCnpj:
          description: CPF o CNPJ del pagador (una cadena v5.5.0).
          type: string
        ispb:
          description: ISPB del participante pagador (8 dígitos, una cadena v5.5.0).
          type: string
        nrAgencia:
          description: >-
            Agencia del pagador (nrAgencia, 4 dígitos, cadena; la fuente de la
            agencia).
          type: string
        nrConta:
          description: >-
            Número de cuenta del pagador (nrConta, una cadena; NUNCA la
            agencia).
          type: string
        tpPessoa:
          description: Tipo de persona (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - ispb
        - tpPessoa
        - cpfCnpj
        - nrConta
      type: object
    InboundRecipientBlock:
      additionalProperties: false
      properties:
        cnpj:
          description: CNPJ del beneficiario (14 dígitos, una cadena v5.5.0).
          type: string
        ispb:
          description: ISPB del participante beneficiario (8 dígitos, una cadena v5.5.0).
          type: string
        nome:
          description: Razón social / nombre comercial del beneficiario (razao social).
          type: string
      required:
        - ispb
        - cnpj
        - nome
      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).

````