MandateRequestCreateDTO

Payload to create a payer-initiated mandate (Jornada 3). The sender data is derived from the (branch, accountNumber) query params.

  • amount
    Type: number
    min:  
    0.01
    required

    Recurring amount per collection (BRL)

  • firstCollectionDate
    Type: string Format: date
    required

    Date of the first collection (ISO date)

  • frequency
    Type: string
    min length:  
    1    enum
    required

    ISO 20022 collection frequency

    values
    • MIAN
    • MNTH
    • QURT
    • WEEK
    • YEAR
    • OTHR
  • receiver
    Type: object · ReceiverDTO2
    required

    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.

  • senderAccountType
    Type: string enum
    required

    ISO 20022 cash account type

    values
    • CACC
    • OTHR
    • SLRY
    • SVGS
    • TRAN
  • finalCollectionDate
    Type: string Format: date

    Optional end date of the mandate. Null means open-ended.