MandateAuthorizationRuleCreateDTO

Payload to create a pre-authorization rule (Jornada 4). All criteria are optional — null means wildcard. A pain.009 mandate matches if it satisfies every non-null criteria.

  • validUntil
    Type: string Format: date-time
    required

    Rule expiration timestamp (UTC). After this, the rule no longer auto-approves.

  • frequencyWhitelist
    Type: array string[] enum

    ISO 20022 frequencies the rule allows. Empty/null = all allowed.

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

    Maximum amount the rule auto-approves (BRL)

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