> ## 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 autorizações de Pix Automático > Lista as autorizações de pagamento recorrente vivas no upstream, escopadas por fluxo + janela de atualização, projetando cada uma sobre o status local da autorização. ## OpenAPI ````yaml pt/openapi/v3-current/pix.yaml GET /v1/pix-automatico/authorizations openapi: 3.0.3 info: title: Plugin BR Pix Direct - API Completa description: > API completa para o sistema de pagamentos instantaneos PIX brasileiro, incluindo operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes, transacoes e limites de transacao. 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 autorizações de Pix Automático description: >- Lista as autorizações de pagamento recorrente vivas no upstream, escopadas por fluxo + janela de atualização, projetando cada uma sobre o status local da autorização. 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: Filtro cnpjRecebedor (string). explode: false in: query name: recipientCnpj schema: description: Filtro cnpjRecebedor (string). type: string - description: filtro tpPessoaPagador (0/1; vazio = sem filtro). explode: false in: query name: payerPersonType schema: description: filtro tpPessoaPagador (0/1; vazio = sem filtro). type: string - description: Filtro cpfCnpjPagador (string). explode: false in: query name: payerDocument schema: description: Filtro cpfCnpjPagador (string). type: string - description: nrAgenciaPagador filtro (string). explode: false in: query name: payerAgency schema: description: nrAgenciaPagador filtro (string). type: string - description: nrContaPagador filtro (string). explode: false in: query name: payerAccount schema: description: nrContaPagador filtro (string). type: string - description: filtro resultadoAutorizacao (true/false; vazio = sem filtro). explode: false in: query name: authorizationOk schema: description: filtro resultadoAutorizacao (true/false; vazio = sem filtro). type: string - description: >- Filtro de status de processo do upstream (0..10; vazio = sem filtro). explode: false in: query name: stJdPiProc schema: description: >- Filtro de status de processo do upstream (0..10; vazio = sem 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 (padrão 1). explode: false in: query name: page schema: description: pagina (padrão 1). format: int64 type: integer - description: tamanhoPagina (padrão 50, máx. 100). explode: false in: query name: pageSize schema: description: tamanhoPagina (padrão 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: Erro components: schemas: ListAuthorizationsResponse: additionalProperties: false properties: authorizations: description: Os snapshots de autorização correspondentes. items: $ref: '#/components/schemas/AuthorizationResponse' type: array nullable: true jdPiAt: description: Data/hora da resposta do upstream (upstream timestamp, UTC). type: string required: - jdPiAt - authorizations type: object Detail: additionalProperties: false properties: code: description: >- Código de erro de domínio estável e legível por máquina, escopado ao serviço emissor (formato: -NNNN). type: string detail: description: Uma explicação legível específica desta ocorrência do problema. type: string errors: description: Lista opcional de detalhes individuais de erro items: $ref: '#/components/schemas/ErrorDetail' type: array nullable: true instance: description: >- Uma referência URI que identifica a ocorrência específica do problema. format: uri type: string status: description: Código de status HTTP format: int64 type: integer title: description: >- Um resumo curto e legível do tipo de problema. Este valor não deve mudar entre ocorrências do erro. type: string type: default: about:blank description: Uma referência URI para a documentação legível do erro. format: uri type: string type: object AuthorizationResponse: additionalProperties: false properties: amount: description: Valor fixo de pagamento em reais. format: double type: number authorizationGiven: description: resultadoAutorizacao. type: boolean authorizedAt: description: Data/hora da autorização (UTC). type: string cancellations: description: Histórico de cancelamentos (cancelamentos). items: $ref: '#/components/schemas/AuthorizationCancellationItem' type: array nullable: true contractDesc: description: Descrição de contrato em texto livre. type: string contractNumber: description: Identificador de contrato/pedido (nrContrato). type: string debtor: $ref: '#/components/schemas/AuthorizationDebtorBody' endDate: description: Data do último pagamento (aaaa-mm-dd). type: string floorMaxAmount: description: Piso do recebedor em reais. format: double type: number frequency: description: tpFrequencia (0..4). format: int64 type: integer idRecorrencia: description: O id da recorrência. type: string idReqJdPi: description: O id da requisição upstream (GUID). type: string idSolicitacao: description: O id da solicitação (29 caracteres, IS...). type: string journey: description: jornada (1..4). format: int64 type: integer localStatus: description: >- AuthorizationStatus local projetado a partir da situação do upstream. type: string localStatusKnown: description: >- False quando a situação do upstream não carrega status local projetado. type: boolean payer: $ref: '#/components/schemas/AuthorizationPayerView' payerMaxAmount: description: Teto máximo do pagador em reais. format: double type: number recipient: $ref: '#/components/schemas/AuthorizationRecipientBody' requestedAt: description: Data/hora da requisição upstream (UTC). type: string retry: description: retentativa (0/1). format: int64 type: integer situationAt: description: Data/hora da situação (dtHrSituacao, UTC). type: string stJdPi: description: Situação geral do upstream (-1/0/9/10). format: int64 type: integer stJdPiProc: description: Situação intermediária do upstream (0..10). format: int64 type: integer startDate: description: Data do primeiro pagamento (aaaa-mm-dd). type: string updatedAt: description: Data/hora da última atualização (UTC). type: string required: - idRecorrencia - stJdPiProc - stJdPi - localStatus - localStatusKnown - authorizationGiven - frequency - startDate - recipient - payer - debtor type: object ErrorDetail: additionalProperties: false properties: location: description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id' type: string message: description: Texto da mensagem de erro type: string value: description: O valor no local informado type: object AuthorizationCancellationItem: additionalProperties: false properties: cancelStatus: description: stCancelamento (0=Aceito, 1=Rejeitado; -1 quando ausente). format: int64 type: integer cancelledAt: description: Data/hora do cancelamento (UTC). type: string errorCode: description: Código de erro do upstream (codigoErro). type: string errorDesc: description: Descrição de erro do upstream (descCodigoErro). type: string idCancelamento: description: O id do cancelamento (29 caracteres, IC...). type: string reason: description: motivoCancelamento (0..10). format: int64 type: integer requesterDocument: description: CPF/CNPJ do solicitante (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: CPF ou CNPJ do devedor (string). type: string name: description: Nome do devedor. 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: Conta do pagador (string). type: string accountType: description: tpConta. format: int64 type: integer agency: description: Agência do pagador (string). type: string cpfCnpj: description: CPF/CNPJ do pagador (string). type: string ibgeCode: description: Código IBGE do município. format: int64 type: integer ispb: description: ISPB do participante pagador (string). type: string name: description: Nome do pagador. type: string personType: description: tpPessoa. format: int64 type: integer type: object AuthorizationRecipientBody: additionalProperties: false properties: cnpj: description: CNPJ do recebedor (14 dígitos, string). type: string ispb: description: ISPB do participante recebedor (8 dígitos, string). type: string name: description: Razão social/nome fantasia do recebedor. type: string required: - ispb - cnpj - name type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Autenticacao por token JWT Bearer. Obtenha o token no endpoint `/v1/login/oauth/access_token` usando credenciais do cliente (clientId e clientSecret). Inclua o token no header Authorization: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` O token expira apos 3600 segundos (1 hora). ````