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

# Listar autorizaciones de Pix Automático

> Lista las autorizaciones de pago recurrente en vivo del upstream, acotadas por flujo + ventana de actualización, proyectando cada una sobre el estado local de la autorización.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml GET /v1/pix-automatico/authorizations
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:
    get:
      tags:
        - Pix Automático API
      summary: Listar autorizaciones de Pix Automático
      description: >-
        Lista las autorizaciones de pago recurrente en vivo del upstream,
        acotadas por flujo + ventana de actualización, proyectando cada una
        sobre el estado local de la autorización.
      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: Filtro cnpjRecebedor (cadena).
            type: string
        - description: tpPessoaPagador filter (0/1; empty = no filter).
          explode: false
          in: query
          name: payerPersonType
          schema:
            description: Filtro tpPessoaPagador (0/1; vacío = sin filtro).
            type: string
        - description: cpfCnpjPagador filter (string).
          explode: false
          in: query
          name: payerDocument
          schema:
            description: Filtro cpfCnpjPagador (cadena).
            type: string
        - description: nrAgenciaPagador filter (string).
          explode: false
          in: query
          name: payerAgency
          schema:
            description: Filtro nrAgenciaPagador (cadena).
            type: string
        - description: nrContaPagador filter (string).
          explode: false
          in: query
          name: payerAccount
          schema:
            description: Filtro nrContaPagador (cadena).
            type: string
        - description: resultadoAutorizacao filter (true/false; empty = no filter).
          explode: false
          in: query
          name: authorizationOk
          schema:
            description: Filtro resultadoAutorizacao (true/false; vacío = sin filtro).
            type: string
        - description: Upstream process status filter (0..10; empty = no filter).
          explode: false
          in: query
          name: stJdPiProc
          schema:
            description: >-
              Filtro de estado de proceso del upstream (0..10; vacío = sin
              filtro).
            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 (por defecto 1).
            format: int64
            type: integer
        - description: tamanhoPagina (default 50, max 100).
          explode: false
          in: query
          name: pageSize
          schema:
            description: tamanhoPagina (por defecto 50, máx. 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: Las instantáneas de autorización coincidentes.
          items:
            $ref: '#/components/schemas/AuthorizationResponse'
          type: array
          nullable: true
        jdPiAt:
          description: >-
            Marca de tiempo de la respuesta del upstream (marca de tiempo del
            upstream, UTC).
          type: string
      required:
        - jdPiAt
        - authorizations
      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
    AuthorizationResponse:
      additionalProperties: false
      properties:
        amount:
          description: Monto fijo del pago en reales.
          format: double
          type: number
        authorizationGiven:
          description: resultadoAutorizacao.
          type: boolean
        authorizedAt:
          description: Marca de tiempo de la autorización (UTC).
          type: string
        cancellations:
          description: Historial de cancelaciones (cancelamentos).
          items:
            $ref: '#/components/schemas/AuthorizationCancellationItem'
          type: array
          nullable: true
        contractDesc:
          description: Descripción de contrato de texto libre.
          type: string
        contractNumber:
          description: Identificador de contrato/orden (nrContrato).
          type: string
        debtor:
          $ref: '#/components/schemas/AuthorizationDebtorBody'
        endDate:
          description: Fecha del último pago (aaaa-mm-dd).
          type: string
        floorMaxAmount:
          description: Monto mínimo del receptor en reales.
          format: double
          type: number
        frequency:
          description: tpFrequencia (0..4).
          format: int64
          type: integer
        idRecorrencia:
          description: El id de recurrencia.
          type: string
        idReqJdPi:
          description: El id de solicitud del upstream (GUID).
          type: string
        idSolicitacao:
          description: El id de solicitud (29 caracteres, IS...).
          type: string
        journey:
          description: jornada (1..4).
          format: int64
          type: integer
        localStatus:
          description: >-
            AuthorizationStatus local proyectado desde la situación del
            upstream.
          type: string
        localStatusKnown:
          description: >-
            False cuando la situación del upstream no lleva ningún estado local
            proyectado.
          type: boolean
        payer:
          $ref: '#/components/schemas/AuthorizationPayerView'
        payerMaxAmount:
          description: Tope máximo del pagador en reales.
          format: double
          type: number
        recipient:
          $ref: '#/components/schemas/AuthorizationRecipientBody'
        requestedAt:
          description: Marca de tiempo de la solicitud en el upstream (UTC).
          type: string
        retry:
          description: retentativa (0/1).
          format: int64
          type: integer
        situationAt:
          description: Marca de tiempo de la situación (dtHrSituacao, UTC).
          type: string
        stJdPi:
          description: Situación general del upstream (-1/0/9/10).
          format: int64
          type: integer
        stJdPiProc:
          description: Situación intermedia del upstream (0..10).
          format: int64
          type: integer
        startDate:
          description: Fecha del primer pago (aaaa-mm-dd).
          type: string
        updatedAt:
          description: Marca de tiempo de la última actualización (UTC).
          type: string
      required:
        - idRecorrencia
        - stJdPiProc
        - stJdPi
        - localStatus
        - localStatusKnown
        - authorizationGiven
        - frequency
        - startDate
        - recipient
        - payer
        - debtor
      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
    AuthorizationCancellationItem:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 cuando está 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 (codigoErro).
          type: string
        errorDesc:
          description: Descripción del error del upstream (descCodigoErro).
          type: string
        idCancelamento:
          description: El id de cancelación (29 caracteres, IC...).
          type: string
        reason:
          description: motivoCancelamento (0..10).
          format: int64
          type: integer
        requesterDocument:
          description: CPF/CNPJ del solicitante (cadena).
          type: string
        requesterType:
          description: tpPessoaSol.
          format: int64
          type: integer
      required:
        - idCancelamento
        - requesterType
        - requesterDocument
        - reason
        - cancelledAt
        - cancelStatus
      type: object
    AuthorizationDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF o CNPJ del deudor (cadena).
          type: string
        name:
          description: Nombre del deudor.
          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: 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
  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).

````