MandateAuthorizationRuleDTO

Pre-authorization rule (Jornada 4). When an inbound pain.009 matches an active rule, the mandate is auto-approved without user intervention.

  • accountNumber
    Type: string

    Owner account number

  • active
    Type: boolean

    Whether the rule is currently active

  • branch
    Type: string

    Owner branch

  • createdAt
    Type: string Format: date-time

    Creation timestamp

  • frequencyWhitelist
    Type: array string[] enum

    Filter: allowed frequencies (empty = all)

    values
    • MIAN
    • MNTH
    • QURT
    • WEEK
    • YEAR
    • OTHR
  • id
    Type: string Format: uuid

    Rule UUID

  • maxAmount
    Type: number

    Filter: maximum amount auto-approved (null = unlimited)

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

  • sender
    Type: object · SenderDTO2

    Payer/sender information

    • account
      Type: object · AccountDTO2

      Bank account information

    • document
      Type: object · DocumentDTO2

      Document identification (CPF or CNPJ)

    • name
      Type: string

      Participant full name.

  • updatedAt
    Type: string Format: date-time

    Last update timestamp

  • validUntil
    Type: string Format: date-time

    Rule expiration timestamp