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

# List Pix Automático authorizations

> Lists live upstream recurring-payment authorizations, scoped by flow + update window, projecting each onto the local authorization status.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml GET /v1/pix-automatico/authorizations
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:
    get:
      tags:
        - Pix Automático API
      summary: List Pix Automático authorizations
      description: >-
        Lists live upstream recurring-payment authorizations, scoped by flow +
        update window, projecting each onto the local authorization status.
      parameters:
        - description: fluxo (0=PSP Pagador, 1=PSP Recebedor).
          explode: false
          in: query
          name: flow
          schema:
            description: fluxo (0=PSP Pagador, 1=PSP Recebedor).
            format: int64
            type: integer
        - description: cnpjRecebedor filter (string).
          explode: false
          in: query
          name: recipientCnpj
          schema:
            description: cnpjRecebedor filter (string).
            type: string
        - description: tpPessoaPagador filter (0/1; empty = no filter).
          explode: false
          in: query
          name: payerPersonType
          schema:
            description: tpPessoaPagador filter (0/1; empty = no filter).
            type: string
        - description: cpfCnpjPagador filter (string).
          explode: false
          in: query
          name: payerDocument
          schema:
            description: cpfCnpjPagador filter (string).
            type: string
        - description: nrAgenciaPagador filter (string).
          explode: false
          in: query
          name: payerAgency
          schema:
            description: nrAgenciaPagador filter (string).
            type: string
        - description: nrContaPagador filter (string).
          explode: false
          in: query
          name: payerAccount
          schema:
            description: nrContaPagador filter (string).
            type: string
        - description: resultadoAutorizacao filter (true/false; empty = no filter).
          explode: false
          in: query
          name: authorizationOk
          schema:
            description: resultadoAutorizacao filter (true/false; empty = no filter).
            type: string
        - description: Upstream process status filter (0..10; empty = no filter).
          explode: false
          in: query
          name: stJdPiProc
          schema:
            description: Upstream process status filter (0..10; empty = no filter).
            type: string
        - description: dtHrAtualizacaoRecorrenciaInicio (UTC).
          explode: false
          in: query
          name: updatedFrom
          schema:
            description: dtHrAtualizacaoRecorrenciaInicio (UTC).
            type: string
        - description: dtHrAtualizacaoRecorrenciaFim (UTC).
          explode: false
          in: query
          name: updatedTo
          schema:
            description: dtHrAtualizacaoRecorrenciaFim (UTC).
            type: string
        - description: pagina (default 1).
          explode: false
          in: query
          name: page
          schema:
            description: pagina (default 1).
            format: int64
            type: integer
        - description: tamanhoPagina (default 50, max 100).
          explode: false
          in: query
          name: pageSize
          schema:
            description: tamanhoPagina (default 50, max 100).
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAuthorizationsResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListAuthorizationsResponse:
      additionalProperties: false
      properties:
        authorizations:
          description: The matching authorization snapshots.
          items:
            $ref: '#/components/schemas/AuthorizationResponse'
          type: array
          nullable: true
        jdPiAt:
          description: Upstream response timestamp (upstream timestamp, UTC).
          type: string
      required:
        - jdPiAt
        - authorizations
      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
    AuthorizationResponse:
      additionalProperties: false
      properties:
        amount:
          description: Fixed payment amount in reais.
          format: double
          type: number
        authorizationGiven:
          description: resultadoAutorizacao.
          type: boolean
        authorizedAt:
          description: Authorization timestamp (UTC).
          type: string
        cancellations:
          description: Cancellation history (cancelamentos).
          items:
            $ref: '#/components/schemas/AuthorizationCancellationItem'
          type: array
          nullable: true
        contractDesc:
          description: Free-text contract description.
          type: string
        contractNumber:
          description: Contract/order identifier (nrContrato).
          type: string
        debtor:
          $ref: '#/components/schemas/AuthorizationDebtorBody'
        endDate:
          description: Last payment date (aaaa-mm-dd).
          type: string
        floorMaxAmount:
          description: Receiver floor in reais.
          format: double
          type: number
        frequency:
          description: tpFrequencia (0..4).
          format: int64
          type: integer
        idRecorrencia:
          description: The recurrence id.
          type: string
        idReqJdPi:
          description: The upstream request id (GUID).
          type: string
        idSolicitacao:
          description: The solicitation id (29-char, IS...).
          type: string
        journey:
          description: jornada (1..4).
          format: int64
          type: integer
        localStatus:
          description: Local AuthorizationStatus projected from the upstream situation.
          type: string
        localStatusKnown:
          description: False when the upstream situation carries no projected local status.
          type: boolean
        payer:
          $ref: '#/components/schemas/AuthorizationPayerView'
        payerMaxAmount:
          description: Payer max cap in reais.
          format: double
          type: number
        recipient:
          $ref: '#/components/schemas/AuthorizationRecipientBody'
        requestedAt:
          description: Upstream request timestamp (UTC).
          type: string
        retry:
          description: retentativa (0/1).
          format: int64
          type: integer
        situationAt:
          description: Situation timestamp (dtHrSituacao, UTC).
          type: string
        stJdPi:
          description: Upstream overall situation (-1/0/9/10).
          format: int64
          type: integer
        stJdPiProc:
          description: Upstream intermediate situation (0..10).
          format: int64
          type: integer
        startDate:
          description: First payment date (aaaa-mm-dd).
          type: string
        updatedAt:
          description: Last-update timestamp (UTC).
          type: string
      required:
        - idRecorrencia
        - stJdPiProc
        - stJdPi
        - localStatus
        - localStatusKnown
        - authorizationGiven
        - frequency
        - startDate
        - recipient
        - payer
        - debtor
      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
    AuthorizationCancellationItem:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent).
          format: int64
          type: integer
        cancelledAt:
          description: Cancellation timestamp (UTC).
          type: string
        errorCode:
          description: Upstream error code (codigoErro).
          type: string
        errorDesc:
          description: Upstream error description (descCodigoErro).
          type: string
        idCancelamento:
          description: The cancellation id (29-char, IC...).
          type: string
        reason:
          description: motivoCancelamento (0..10).
          format: int64
          type: integer
        requesterDocument:
          description: Requester CPF/CNPJ (string).
          type: string
        requesterType:
          description: tpPessoaSol.
          format: int64
          type: integer
      required:
        - idCancelamento
        - requesterType
        - requesterDocument
        - reason
        - cancelledAt
        - cancelStatus
      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
    AuthorizationPayerView:
      additionalProperties: false
      properties:
        account:
          description: Payer account (string).
          type: string
        accountType:
          description: tpConta.
          format: int64
          type: integer
        agency:
          description: Payer branch (string).
          type: string
        cpfCnpj:
          description: Payer CPF/CNPJ (string).
          type: string
        ibgeCode:
          description: Municipality IBGE code.
          format: int64
          type: integer
        ispb:
          description: Payer participant ISPB (string).
          type: string
        name:
          description: Payer name.
          type: string
        personType:
          description: tpPessoa.
          format: int64
          type: integer
      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
  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).

````