> ## 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 agendamentos de Pix Automático > Lista as instruções de pagamento agendadas vivas no upstream, escopadas por fluxo + janela de vencimento, projetando cada uma sobre o status local do agendamento. A resposta é um objeto wrapper carregando o carimbo de data/hora do upstream e os snapshots dos agendamentos. ## OpenAPI ````yaml pt/openapi/v3-current/pix.yaml GET /v1/pix-automatico/schedules/list 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/schedules/list: get: tags: - Pix Automático API summary: Listar agendamentos de Pix Automático description: >- Lista as instruções de pagamento agendadas vivas no upstream, escopadas por fluxo + janela de vencimento, projetando cada uma sobre o status local do agendamento. A resposta é um objeto wrapper carregando o carimbo de data/hora do upstream e os snapshots dos agendamentos. parameters: - description: fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador). explode: false in: query name: flow schema: description: fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador). 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 stAgendamento (0/1; vazio = sem filtro). explode: false in: query name: scheduleStatus schema: description: filtro stAgendamento (0/1; vazio = sem filtro). type: string - description: dtVencimentoInicio (aaaa-mm-dd). explode: false in: query name: dueDateFrom schema: description: dtVencimentoInicio (aaaa-mm-dd). type: string - description: dtVencimentoFim (aaaa-mm-dd). explode: false in: query name: dueDateTo schema: description: dtVencimentoFim (aaaa-mm-dd). 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/ListSchedulesResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Erro components: schemas: ListSchedulesResponse: additionalProperties: false properties: jdPiAt: description: Data/hora da resposta do upstream (upstream timestamp, UTC). type: string schedules: description: Os snapshots de agendamento correspondentes (agendamentos). items: $ref: '#/components/schemas/ScheduleResponse' type: array nullable: true required: - jdPiAt - schedules 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 ScheduleResponse: additionalProperties: false properties: acceptRejectAt: description: Data/hora de aceite/rejeição (dtHrAceiteRejeite, UTC). type: string amount: description: Valor agendado em reais. format: double type: number cancellations: description: Histórico de cancelamento (cancelamento). items: $ref: '#/components/schemas/ScheduleCancellationItem' type: array nullable: true debtor: $ref: '#/components/schemas/ScheduleDebtorView' dueDate: description: Data de vencimento (aaaa-mm-dd). type: string endToEndId: description: O id da transação de pagamento (32 caracteres). type: string errorCode: description: Código de erro do upstream. type: string errorDesc: description: Descrição de erro do upstream. type: string idRecorrencia: description: O id da recorrência (RR...). type: string infoBetweenClients: description: Informação em texto livre do recebedor para o pagador. type: string localStatus: description: ScheduleStatus 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/ScheduleParty' purpose: description: finalidadeAgendamento. format: int64 type: integer recipient: $ref: '#/components/schemas/ScheduleParty' recipientReceivedAt: description: Data/hora de recepção do PSP recebedor (UTC). type: string reconciliationId: description: O id de conciliação do recebedor. type: string requestedAt: description: Data/hora da requisição upstream (UTC). type: string scheduleStatus: description: stAgendamento (0=Aceito, 1=Rejeitado; -1 quando ausente). 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/11). format: int64 type: integer stJdPiProc: description: Situação intermediária do upstream (0/1/2/5/7/8/9/10/11). format: int64 type: integer required: - endToEndId - idRecorrencia - scheduleStatus - stJdPiProc - stJdPi - localStatus - localStatusKnown - 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 ScheduleCancellationItem: 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, CA...). type: string reason: description: motivoCancelamento (0..6). format: int64 type: integer recipientIspb: description: ispbDestinatario (string). type: string requesterDocument: description: CPF/CNPJ do solicitante (string). type: string requesterIspb: description: ispbSolicitante (string). type: string requesterType: description: tpPessoaSol. format: int64 type: integer required: - idCancelamento - requesterIspb - recipientIspb - requesterType - requesterDocument - reason - cancelledAt - cancelStatus type: object ScheduleDebtorView: additionalProperties: false properties: cpfCnpj: description: CPF/CNPJ do devedor (string). type: string name: description: Nome do devedor. type: string personType: description: tpPessoa. format: int64 type: integer type: object ScheduleParty: additionalProperties: false properties: account: description: Número da conta (nrConta, string). type: string accountType: description: tpConta. format: int64 type: integer agency: description: Agência (nrAgencia, string). type: string cnpj: description: CNPJ (string). type: string cpfCnpj: description: CPF/CNPJ (string). type: string ispb: description: ISPB do participante (string). type: string name: description: Nome legal/fantasia. type: string personType: description: tpPessoa. format: int64 type: integer 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). ````