PixRequestRecurrenceResponseDTO

  • 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

    • document
      Type: object · DocumentDTO
      required

      Document identification (CPF or CNPJ)

    • name
      Type: string
      min length:  
      1
      required

      Receiver full name.

    • account
      Type: object · AccountDTO

      Bank account information

    • key
      Type: string

      Receiver Pix key.

  • 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

    • account
      Type: object · AccountDTO
      required

      Bank account information

    • document
      Type: object · DocumentDTO
      required

      Document identification (CPF or CNPJ)

    • name
      Type: string
      min length:  
      1
      required

      Participant full name.

  • 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.