> ## 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 programaciones de Pix Automático > Lista las instrucciones de pago programadas en vivo del upstream, acotadas por flujo + ventana de vencimiento, proyectando cada una sobre el estado local de la programación. La respuesta es un objeto envoltorio que lleva la marca de tiempo del upstream y las instantáneas de las programaciones. ## OpenAPI ````yaml es/openapi/v3-current/pix.yaml GET /v1/pix-automatico/schedules/list 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/schedules/list: get: tags: - Pix Automático API summary: Listar programaciones de Pix Automático description: >- Lista las instrucciones de pago programadas en vivo del upstream, acotadas por flujo + ventana de vencimiento, proyectando cada una sobre el estado local de la programación. La respuesta es un objeto envoltorio que lleva la marca de tiempo del upstream y las instantáneas de las programaciones. 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: 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: stAgendamento filter (0/1; empty = no filter). explode: false in: query name: scheduleStatus schema: description: Filtro stAgendamento (0/1; vacío = sin 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 (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/ListSchedulesResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: ListSchedulesResponse: additionalProperties: false properties: jdPiAt: description: >- Marca de tiempo de la respuesta del upstream (marca de tiempo del upstream, UTC). type: string schedules: description: Las instantáneas de programación coincidentes (agendamentos). items: $ref: '#/components/schemas/ScheduleResponse' type: array nullable: true required: - jdPiAt - schedules 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: -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 ScheduleResponse: additionalProperties: false properties: acceptRejectAt: description: Marca de tiempo de aceptación/rechazo (dtHrAceiteRejeite, UTC). type: string amount: description: Monto programado en reales. format: double type: number cancellations: description: Historial de cancelaciones (cancelamento). items: $ref: '#/components/schemas/ScheduleCancellationItem' type: array nullable: true debtor: $ref: '#/components/schemas/ScheduleDebtorView' dueDate: description: Fecha de vencimiento (aaaa-mm-dd). type: string endToEndId: description: El id de la transacción de pago (32 caracteres). type: string errorCode: description: Código de error del upstream. type: string errorDesc: description: Descripción del error del upstream. type: string idRecorrencia: description: El id de recurrencia (RR...). type: string infoBetweenClients: description: Información del receptor al pagador de texto libre. type: string localStatus: description: ScheduleStatus 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/ScheduleParty' purpose: description: finalidadeAgendamento. format: int64 type: integer recipient: $ref: '#/components/schemas/ScheduleParty' recipientReceivedAt: description: Marca de tiempo de recepción del PSP beneficiario (UTC). type: string reconciliationId: description: El id de conciliación del receptor. type: string requestedAt: description: Marca de tiempo de la solicitud en el upstream (UTC). type: string scheduleStatus: description: stAgendamento (0=Aceito, 1=Rejeitado; -1 cuando está ausente). 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/11). format: int64 type: integer stJdPiProc: description: Situación intermedia del 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: >- 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 ScheduleCancellationItem: 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, CA...). type: string reason: description: motivoCancelamento (0..6). format: int64 type: integer recipientIspb: description: ispbDestinatario (cadena). type: string requesterDocument: description: CPF/CNPJ del solicitante (cadena). type: string requesterIspb: description: ispbSolicitante (cadena). 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 del deudor (cadena). type: string name: description: Nombre del deudor. type: string personType: description: tpPessoa. format: int64 type: integer type: object ScheduleParty: additionalProperties: false properties: account: description: Número de cuenta (nrConta, cadena). type: string accountType: description: tpConta. format: int64 type: integer agency: description: Agencia (nrAgencia, cadena). type: string cnpj: description: CNPJ (cadena). type: string cpfCnpj: description: CPF/CNPJ (cadena). type: string ispb: description: ISPB del participante (cadena). type: string name: description: Razón social / nombre comercial. type: string personType: description: tpPessoa. format: int64 type: integer 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). ````