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

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



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml GET /v1/pix-automatico/authorizations/{idRecorrencia}/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/authorizations/{idRecorrencia}/cancel/{idCancelamento}:
    get:
      tags:
        - Pix Automático API
      summary: Consultar una cancelación de autorización de Pix Automático
      description: >-
        Consulta la situación en vivo del upstream de una cancelación de
        autorización, indexada por (idRecorrencia, idCancelamento).
      parameters:
        - description: The recurrence id (29-char, RR...).
          in: path
          name: idRecorrencia
          required: true
          schema:
            description: El id de recurrencia (29 caracteres, RR...).
            type: string
        - description: The cancellation id (29-char, IC...).
          in: path
          name: idCancelamento
          required: true
          schema:
            description: El id de cancelación (29 caracteres, IC...).
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancellationDetailResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    CancellationDetailResponse:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 ausente).
          format: int64
          type: integer
        cancelledAt:
          description: Marca de tiempo de la cancelación (UTC).
          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 (IC...).
          type: string
        idRecorrencia:
          description: El id de recurrencia.
          type: string
        payer:
          $ref: '#/components/schemas/AuthorizationPayerView'
        reason:
          description: motivoCancelamento (0..10).
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/AuthorizationRecipientBody'
        requesterDocument:
          description: CPF/CNPJ del solicitante (cadena).
          type: string
        requesterType:
          description: tpPessoaSol.
          format: int64
          type: integer
        situationAt:
          description: Marca de tiempo de la situación (UTC).
          type: string
      required:
        - idRecorrencia
        - idCancelamento
        - requesterType
        - requesterDocument
        - reason
        - cancelStatus
        - recipient
        - payer
      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
    AuthorizationPayerView:
      additionalProperties: false
      properties:
        account:
          description: Cuenta del pagador (cadena).
          type: string
        accountType:
          description: tpConta.
          format: int64
          type: integer
        agency:
          description: Agencia del pagador (cadena).
          type: string
        cpfCnpj:
          description: CPF/CNPJ del pagador (cadena).
          type: string
        ibgeCode:
          description: Código IBGE del municipio.
          format: int64
          type: integer
        ispb:
          description: ISPB del participante pagador (cadena).
          type: string
        name:
          description: Nombre del pagador.
          type: string
        personType:
          description: tpPessoa.
          format: int64
          type: integer
      type: object
    AuthorizationRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: CNPJ del beneficiario (14 dígitos, cadena).
          type: string
        ispb:
          description: ISPB del participante beneficiario (8 dígitos, cadena).
          type: string
        name:
          description: Razón social / nombre comercial del beneficiario.
          type: string
      required:
        - ispb
        - cnpj
        - name
      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).

````