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

# Cancel a PIX Automatico authorization

> Cancels a recurring-payment authorization (JDPI 4.3.5), transitioning it to Cancelled and soft-deleting the local row. Returns the cancellation id (idCancelamento).



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/cancel
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/pix-automatico/authorizations/{idRecorrencia}/cancel:
    post:
      tags:
        - PIX Automatico
      summary: Cancel a PIX Automatico authorization
      description: >-
        Cancels a recurring-payment authorization (JDPI 4.3.5), transitioning it
        to Cancelled and soft-deleting the local row. Returns the cancellation
        id (idCancelamento).
      operationId: cancelPixAutomaticoAuthorization
      parameters:
        - description: The recurrence id (29-char, RR...).
          in: path
          name: idRecorrencia
          required: true
          schema:
            description: The recurrence id (29-char, RR...).
            examples:
              - RR0435879820240605njua7shf40o
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelAuthorizationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelAuthorizationResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    CancelAuthorizationBody:
      additionalProperties: false
      properties:
        reason:
          description: motivoCancelamento (0..10).
          examples:
            - 0
          format: int64
          type: integer
        requesterDocument:
          description: Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).
          examples:
            - '04623217035'
          type: string
        requesterType:
          description: tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - requesterType
        - requesterDocument
        - reason
      type: object
    CancelAuthorizationResponse:
      additionalProperties: false
      properties:
        cancelledAt:
          description: Cancellation timestamp (dtHrCancelamento, UTC).
          examples:
            - '2024-02-01T10:00:00Z'
          type: string
        idCancelamento:
          description: The cancellation id (29-char, IC...).
          examples:
            - IC0435879820240605abcd1234567
          type: string
        idRecorrencia:
          description: The recurrence id.
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        status:
          description: The resulting local authorization status.
          examples:
            - Cancelled
          type: string
      required:
        - idRecorrencia
        - idCancelamento
        - cancelledAt
        - status
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````