MandateAuthorizationRuleUpdateDTO

Partial update payload for an authorization rule. Only non-null fields are applied.

  • active
    Type: boolean

    Activate (true) or deactivate (false) the rule

  • frequencyWhitelist
    Type: array string[] enum

    Update frequency whitelist

    values
    • MIAN
    • MNTH
    • QURT
    • WEEK
    • YEAR
    • OTHR
  • maxAmount
    Type: number

    Update maximum amount

  • receiver
    Type: object · ReceiverDTO2

    Receiver/beneficiary information

    • document
      Type: object · DocumentDTO2
      required

      Document identification (CPF or CNPJ)

    • name
      Type: string
      min length:  
      1
      required

      Receiver full name.

    • account
      Type: object · AccountDTO2

      Bank account information

    • key
      Type: string

      Receiver Pix key.

  • validUntil
    Type: string Format: date-time

    Update expiration timestamp