PixRequestScheduleUpdateDTO

  • amount
    Type: number
    min:  
    0.01
    required

    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.

  • scheduledDate
    Type: string Format: date
    required

    Date when this schedule will be executed (yyyy-MM-dd).

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

  • 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
  • userDescription
    Type: string

    User-provided description.