MandateRequestCreateDTO

Payload to register a recurrence read from a composite QR Code (jornadas 2, 3 and 4), so the payer can authorise it afterwards. Every field maps to the QR decode response; the payer account comes from the branch and accountNumber query params.

  • firstCollectionDate
    Type: string Format: date
    required

    Date of the first collection — recurrence.startDate.

  • journey
    Type: integer Format: int32
    min:  
    2
    max:  
    4
    required

    Authorisation journey (AUTn): 2 QR with recurrence parameters, 3 payer-initiated, 4 composite-QR payment. J1 is inbound-only.

  • periodicity
    Type: string enum
    required

    Collection periodicity exactly as the QR decode returns it in recurrence.periodicity.

    values
    • SEMANAL
    • MENSAL
    • TRIMESTRAL
    • SEMESTRAL
    • ANUAL
  • 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.

  • recurrenceId
    Type: string
    min length:  
    1
    required

    Id the receiving PSP assigned to the recurrence, as printed in the composite QR Code. Returned by the QR decode as recurrence.recurrenceId.

  • senderAccountType
    Type: string enum
    required

    ISO 20022 cash account type of the payer account

    values
    • CACC
    • OTHR
    • SLRY
    • SVGS
    • TRAN
  • senderDocument
    Type: string
    min length:  
    1
    required

    Payer document without mask — 11 digits for CPF, 14 characters for CNPJ, which IN RFB nº 2.229/2024 allows to carry letters in the first twelve positions.

  • amount
    Type: number
    min:  
    0.01

    Amount per collection (BRL). Absent on variable-amount recurrences.

  • finalCollectionDate
    Type: string Format: date

    Last date collections may occur — recurrence.endDate. Null means open-ended.