> ## 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 Automatico schedules

> Lists live JDPI scheduled payment instructions (JDPI 4.4.5), scoped by flow + due-date window, projecting each onto the local schedule status. The response is an object wrapper carrying the JDPI timestamp and the schedule snapshots.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/list
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/pix-automatico/schedules/list:
    get:
      tags:
        - PIX Automatico
      summary: List PIX Automatico schedules
      description: >-
        Lists live JDPI scheduled payment instructions (JDPI 4.4.5), scoped by
        flow + due-date window, projecting each onto the local schedule status.
        The response is an object wrapper carrying the JDPI timestamp and the
        schedule snapshots.
      operationId: listPixAutomaticoSchedules
      parameters:
        - description: fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador).
          explode: false
          in: query
          name: flow
          required: true
          schema:
            description: fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador).
            examples:
              - 0
            format: int64
            type: integer
        - description: cnpjRecebedor filter (string).
          explode: false
          in: query
          name: recipientCnpj
          schema:
            description: cnpjRecebedor filter (string).
            examples:
              - '61695227000193'
            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).
            examples:
              - '0'
            type: string
        - description: cpfCnpjPagador filter (string).
          explode: false
          in: query
          name: payerDocument
          schema:
            description: cpfCnpjPagador filter (string).
            examples:
              - '04623217035'
            type: string
        - description: nrAgenciaPagador filter (string).
          explode: false
          in: query
          name: payerAgency
          schema:
            description: nrAgenciaPagador filter (string).
            examples:
              - '0001'
            type: string
        - description: nrContaPagador filter (string).
          explode: false
          in: query
          name: payerAccount
          schema:
            description: nrContaPagador filter (string).
            examples:
              - '0007654321'
            type: string
        - description: stAgendamento filter (0/1; empty = no filter).
          explode: false
          in: query
          name: scheduleStatus
          schema:
            description: stAgendamento filter (0/1; empty = no filter).
            examples:
              - '0'
            type: string
        - description: dtVencimentoInicio (aaaa-mm-dd).
          explode: false
          in: query
          name: dueDateFrom
          required: true
          schema:
            description: dtVencimentoInicio (aaaa-mm-dd).
            examples:
              - '2024-09-01'
            type: string
        - description: dtVencimentoFim (aaaa-mm-dd).
          explode: false
          in: query
          name: dueDateTo
          required: true
          schema:
            description: dtVencimentoFim (aaaa-mm-dd).
            examples:
              - '2024-09-30'
            type: string
        - description: pagina (default 1).
          explode: false
          in: query
          name: page
          schema:
            description: pagina (default 1).
            examples:
              - 1
            format: int64
            type: integer
        - description: tamanhoPagina (default 50, max 100).
          explode: false
          in: query
          name: pageSize
          schema:
            description: tamanhoPagina (default 50, max 100).
            examples:
              - 50
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSchedulesResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListSchedulesResponse:
      additionalProperties: false
      properties:
        jdPiAt:
          description: JDPI response timestamp (dtHrJdPi, UTC).
          examples:
            - '2024-06-08T06:00:05Z'
          type: string
        schedules:
          description: The matching schedule snapshots (agendamentos).
          items:
            $ref: '#/components/schemas/ScheduleResponse'
          type:
            - array
            - 'null'
      required:
        - jdPiAt
        - schedules
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          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.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ScheduleResponse:
      additionalProperties: false
      properties:
        acceptRejectAt:
          description: Accept/reject timestamp (dtHrAceiteRejeite, UTC).
          examples:
            - '2024-09-17T15:10:05Z'
          type: string
        amount:
          description: Scheduled amount in centavos.
          examples:
            - 55000
          format: int64
          type: integer
        cancellations:
          description: Cancellation history (cancelamento).
          items:
            $ref: '#/components/schemas/ScheduleCancellationItem'
          type:
            - array
            - 'null'
        debtor:
          $ref: '#/components/schemas/ScheduleDebtorView'
          description: The scheduled devedor.
        dueDate:
          description: Due date (aaaa-mm-dd).
          examples:
            - '2024-09-24'
          type: string
        endToEndId:
          description: The payment-transaction id (32-char).
          examples:
            - E00038166202409171500y6j6mt9l0pi
          type: string
        errorCode:
          description: JDPI error code.
          examples:
            - ''
          type: string
        errorDesc:
          description: JDPI error description.
          examples:
            - ''
          type: string
        idRecorrencia:
          description: The recurrence id (RR...).
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        infoBetweenClients:
          description: Free-text receiver-to-payer info.
          examples:
            - ''
          type: string
        localStatus:
          description: Local ScheduleStatus projected from the JDPI situation.
          examples:
            - Accepted
          type: string
        localStatusKnown:
          description: False when the JDPI situation carries no projected local status.
          examples:
            - true
          type: boolean
        payer:
          $ref: '#/components/schemas/ScheduleParty'
          description: The scheduled pagador.
        purpose:
          description: finalidadeAgendamento.
          examples:
            - 0
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/ScheduleParty'
          description: The scheduled recebedor.
        recipientReceivedAt:
          description: Recipient PSP reception timestamp (UTC).
          examples:
            - '2024-09-17T10:25:49Z'
          type: string
        reconciliationId:
          description: The receiver conciliation id.
          examples:
            - JDPI2024091700000000000000000000001
          type: string
        requestedAt:
          description: JDPI request timestamp (UTC).
          examples:
            - '2024-09-17T10:10:05Z'
          type: string
        scheduleStatus:
          description: stAgendamento (0=Aceito, 1=Rejeitado; -1 when absent).
          examples:
            - 0
          format: int64
          type: integer
        situationAt:
          description: Situation timestamp (dtHrSituacao, UTC).
          examples:
            - '2024-09-18T16:34:18Z'
          type: string
        stJdPi:
          description: JDPI overall situation (-1/0/9/10/11).
          examples:
            - 9
          format: int64
          type: integer
        stJdPiProc:
          description: JDPI intermediate situation (0/1/2/5/7/8/9/10/11).
          examples:
            - 9
          format: int64
          type: integer
      required:
        - endToEndId
        - idRecorrencia
        - scheduleStatus
        - stJdPiProc
        - stJdPi
        - localStatus
        - localStatusKnown
        - 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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
    ScheduleCancellationItem:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent).
          examples:
            - 0
          format: int64
          type: integer
        cancelledAt:
          description: Cancellation timestamp (UTC).
          examples:
            - '2024-10-01T10:00:00Z'
          type: string
        errorCode:
          description: JDPI error code (codigoErro).
          examples:
            - ''
          type: string
        errorDesc:
          description: JDPI error description (descCodigoErro).
          examples:
            - ''
          type: string
        idCancelamento:
          description: The cancellation id (29-char, CA...).
          examples:
            - CA0435879820240605abcd1234567
          type: string
        reason:
          description: motivoCancelamento (0..6).
          examples:
            - 0
          format: int64
          type: integer
        recipientIspb:
          description: ispbDestinatario (string).
          examples:
            - '00038166'
          type: string
        requesterDocument:
          description: Requester CPF/CNPJ (string).
          examples:
            - '04623217035'
          type: string
        requesterIspb:
          description: ispbSolicitante (string).
          examples:
            - '04358798'
          type: string
        requesterType:
          description: tpPessoaSol.
          examples:
            - 0
          format: int64
          type: integer
      required:
        - idCancelamento
        - requesterIspb
        - recipientIspb
        - requesterType
        - requesterDocument
        - reason
        - cancelledAt
        - cancelStatus
      type: object
    ScheduleDebtorView:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF/CNPJ (string).
          examples:
            - '04623217035'
          type: string
        name:
          description: Debtor name.
          examples:
            - Ciclano da Silva
          type: string
        personType:
          description: tpPessoa.
          examples:
            - 0
          format: int64
          type: integer
      type: object
    ScheduleParty:
      additionalProperties: false
      properties:
        account:
          description: Account number (nrConta, string).
          examples:
            - '0007654321'
          type: string
        accountType:
          description: tpConta.
          examples:
            - 0
          format: int64
          type: integer
        agency:
          description: Branch (nrAgencia, string).
          examples:
            - '0001'
          type: string
        cnpj:
          description: CNPJ (string).
          examples:
            - '61695227000193'
          type: string
        cpfCnpj:
          description: CPF/CNPJ (string).
          examples:
            - '04623217035'
          type: string
        ispb:
          description: Participant ISPB (string).
          examples:
            - '04358798'
          type: string
        name:
          description: Legal/trade name.
          examples:
            - Enel
          type: string
        personType:
          description: tpPessoa.
          examples:
            - 0
          format: int64
          type: integer
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````