OffsetPageResultPixRequestRecurrenceResponseDTO

Paginated result using offset-based pagination

  • hasNext
    Type: boolean

    Indicates whether a next page exists

  • items
    Type: array object[] · PixRequestRecurrenceResponseDTO[]

    List of records returned on the current page

    • amount
      Type: number

      Amount.

    • createdAt
      Type: string

      Creation timestamp in ISO-8601 format.

    • id
      Type: string

      Identifier (UUID).

    • initiationMethod
      Type: string enum

      Payment initiation method.

      values
      • APDN
      • APES
      • AUTO
      • DICT
      • INIC
      • MANU
      • QRDN
      • QRES
    • lastExecutionDate
      Type: string Format: date

      Last execution date in ISO format (yyyy-MM-dd).

    • nextExecutionDate
      Type: string Format: date

      Next execution date in ISO format (yyyy-MM-dd).

    • priority
      Type: string enum

      Payment priority for the outgoing Pix request (SPI band: HIGH → HIGH, NORM → NORM)

      values
      • HIGH
      • NORM
    • priorityType
      Type: string enum

      Priority type code (BACEN SPI)

      values
      • PAGAGD
      • PAGFRD
      • PAGPRI
    • purpose
      Type: string enum

      Purpose of the outgoing Pix payment (SPI purpose codes)

      values
      • GSCB
      • IPAY
      • IPRT
      • OTHR
      • REFU
    • receiver
      Type: object · ReceiverDTO

      Receiver/beneficiary information for the Pix transaction

    • recurrence
      Type: string enum

      Recurrence frequency.

      values
      • WEEKLY
      • BIWEEKLY
      • MONTHLY
    • recurrenceEndDate
      Type: string Format: date

      Recurrence end date in ISO format (yyyy-MM-dd). NULL for open-ended recurrences.

    • sender
      Type: object · SenderDTO

      Payer/sender information for the Pix transaction

    • source
      Type: string enum

      Origin.

      values
      • MANUAL
      • PIX_AUTOMATIC
    • startDate
      Type: string Format: date

      Recurrence start date in ISO format (yyyy-MM-dd).

    • status
      Type: string enum

      Status.

      values
      • ACTIVE
      • INACTIVE
      • COMPLETED
      • REJECTED
      • EXPIRED
      • PENDING
    • totalInstallments
      Type: integer Format: int32

      Total installments planned for this recurrence. NULL for open-ended recurrences.

    • updatedAt
      Type: string

      Update timestamp in ISO-8601 format.

    • userDescription
      Type: string

      User-provided description.

  • page
    Type: integer Format: int32

    Current page number (zero-based)

  • size
    Type: integer Format: int32

    Number of records per page

  • totalItems
    Type: integer Format: int64

    Total number of records matching the query

  • totalPages
    Type: integer Format: int32

    Total number of pages available