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

# Confirm a Pix Automático authorization

> Confirms a recurring-payment authorization via QR journeys 2-4, transitioning it to Active (the live recurring-payment mandate).



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml POST /v1/pix-automatico/authorizations/{idRecorrencia}/confirm
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  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}/confirm:
    post:
      tags:
        - Pix Automático API
      summary: Confirm a Pix Automático authorization
      description: >-
        Confirms a recurring-payment authorization via QR journeys 2-4,
        transitioning it to Active (the live recurring-payment mandate).
      parameters:
        - description: The recurrence id (29-char, RR...).
          in: path
          name: idRecorrencia
          required: true
          schema:
            description: The recurrence id (29-char, RR...).
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmAuthorizationBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationAckResponse'
          description: Accepted
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ConfirmAuthorizationBody:
      additionalProperties: false
      properties:
        amount:
          description: Fixed payment amount in reais (valor).
          format: double
          type: number
        authorizedAt:
          description: Authorization timestamp (dtHrAutorizacaoRecorrencia, UTC).
          type: string
        contractDesc:
          description: Free-text contract description.
          type: string
        contractNumber:
          description: Contract/order identifier (nrContrato).
          type: string
        createdDateTime:
          description: Recurrence creation timestamp (dtHrCriacaoRecorrencia, UTC).
          type: string
        debtor:
          $ref: '#/components/schemas/AuthorizationDebtorBody'
        endDate:
          description: Last payment date (dtFinalRecorrencia).
          type: string
        floorMaxAmount:
          description: Receiver floor in reais (pisoValorMaximo).
          format: double
          type: number
        frequency:
          description: tpFrequencia (0..4).
          format: int64
          type: integer
        journey:
          description: jornada (2..4).
          format: int64
          type: integer
        payer:
          $ref: '#/components/schemas/ConfirmPayerBody'
        payerMaxAmount:
          description: Payer max cap in reais (vlrMaxPagador).
          format: double
          type: number
        recipient:
          $ref: '#/components/schemas/AuthorizationRecipientBody'
        settlementConfirmedAt:
          description: >-
            Settlement confirmation timestamp (dtHrConfirmacaoLiquidacao, UTC;
            required for jornada=3).
          type: string
        startDate:
          description: First payment date (dtInicialRecorrencia; aaaa-mm-dd).
          type: string
      required:
        - journey
        - frequency
        - startDate
        - recipient
        - payer
        - contractNumber
      type: object
    AuthorizationAckResponse:
      additionalProperties: false
      properties:
        idRecorrencia:
          description: The recurrence id.
          type: string
        idReqJdPi:
          description: The upstream request id (36-char GUID; omitted by 4.3.10).
          type: string
        requestedAt:
          description: Upstream request timestamp (upstream request timestamp, UTC).
          type: string
        status:
          description: The resulting local authorization status.
          type: string
      required:
        - idRecorrencia
        - requestedAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          type: string
      type: object
    AuthorizationDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ (string).
          type: string
        name:
          description: Debtor name.
          type: string
        personType:
          description: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    ConfirmPayerBody:
      additionalProperties: false
      properties:
        account:
          description: Payer account number (nrConta, string).
          type: string
        accountType:
          description: tpConta (0..3).
          format: int64
          type: integer
        agency:
          description: Payer branch (nrAgencia, string).
          type: string
        cpfCnpj:
          description: Payer CPF or CNPJ (string).
          type: string
        ibgeCode:
          description: Municipality IBGE code (codMunIbge).
          format: int64
          type: integer
        ispb:
          description: Payer participant ISPB (8 digits, string).
          type: string
        name:
          description: Payer name (nomePagador).
          type: string
        personType:
          description: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - ispb
        - personType
        - cpfCnpj
        - name
        - account
        - accountType
        - ibgeCode
      type: object
    AuthorizationRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: Recipient CNPJ (14 digits, string).
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, string).
          type: string
        name:
          description: Recipient legal/trade name.
          type: string
      required:
        - ispb
        - cnpj
        - name
      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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````