PixRequestRecurrenceCreateDTO

Request payload for creating a recurring Pix schedule. Materializes one or more single schedules linked to this recurrence.

  • amount
    Type: number
    required

    Transaction amount.

  • initiationMethod
    Type: string enum
    required

    Payment initiation method.

    values
    • APDN
    • APES
    • AUTO
    • DICT
    • INIC
    • MANU
    • QRDN
    • QRES
  • receiver
    Type: object · ReceiverDTO
    required

    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
    required

    Recurrence frequency. Options: WEEKLY, BIWEEKLY, MONTHLY.

    values
    • WEEKLY
    • BIWEEKLY
    • MONTHLY
  • sender
    Type: object · SenderDTO
    required

    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.

  • startDate
    Type: string Format: date
    required

    Start date of the recurrence in ISO format (yyyy-MM-dd). The first installment is materialized on this date.

  • description
    Type: string

    Payment description or message to the receiver.

  • metadata
    Type: array object[] · MetadataDTO[]

    Optional list of custom key/value pairs.

    Key/value metadata item

    • key
      Type: string
      min length:  
      1
      required

      Metadata key

    • value
      Type: string

      Metadata value

  • priority
    Type: string enum

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

    values
    • HIGH
    • NORM
  • purpose
    Type: string enum

    Purpose of the outgoing Pix payment (SPI purpose codes)

    values
    • GSCB
    • IPAY
    • IPRT
    • OTHR
    • REFU
  • reconciliationId
    Type: string

    Client reconciliation identifier for reporting and matching.

  • recurrenceEndDate
    Type: string Format: date

    End date for recurrence in ISO format (yyyy-MM-dd). When provided, every installment up to this date is materialized at creation time. When omitted, the recurrence is open-ended and the worker materializes the next installment after each execution.

  • source
    Type: string enum

    Origin. Defaults to MANUAL.

    values
    • MANUAL
    • PIX_AUTOMATIC