MandatePageResponseDTO

Paginated response of mandates.

  • content
    Type: array object[] · MandateResponseDTO[]

    Items in the current page

    Full state of a mandate (recurring authorization) in the payer's view.

    • activatedAt
      Type: string Format: date-time

      Timestamp when the mandate became ACTIVE (after pain.012 inbound ACK)

    • amount
      Type: number

      Recurring amount per collection (BRL)

    • approvedAt
      Type: string Format: date-time

      Timestamp of user approval (set when status becomes APPROVAL_SENT)

    • cancellationReason
      Type: string

      BACEN cancellation reason code

    • cancelledAt
      Type: string Format: date-time

      Timestamp of cancellation

    • cancelledBy
      Type: string enum

      Who cancelled the mandate

      values
      • SELF
      • COUNTERPARTY
    • createdAt
      Type: string Format: date-time

      Record creation timestamp

    • finalCollectionDate
      Type: string Format: date

      Optional final collection date (null = open-ended)

    • firstCollectionDate
      Type: string Format: date

      Date of the first scheduled collection

    • frequency
      Type: string enum

      ISO 20022 collection frequency

      values
      • MIAN
      • MNTH
      • QURT
      • WEEK
      • YEAR
      • OTHR
    • mandateId
      Type: string

      Unique mandate identifier (BACEN format SC + ISPB + timestamp + random)

    • mandateRequestId
      Type: string

      If created via Jornada 3 (payer-initiated), this is the original request id

    • receivedAt
      Type: string Format: date-time

      Timestamp when the original pain.009 was received

    • receiver
      Type: object · ReceiverDTO2

      Receiver/beneficiary information

    • rejectedAt
      Type: string Format: date-time

      Timestamp of rejection

    • rejectReason
      Type: string

      BACEN reject reason code (e.g. MD01)

    • sender
      Type: object · SenderDTO2

      Payer/sender information

    • status
      Type: string enum

      Current mandate status

      values
      • PENDING_USER_APPROVAL
      • PENDING_COUNTERPARTY_APPROVAL
      • APPROVAL_SENT
      • ACTIVE
      • REJECTED
      • CANCELLED
      • EXPIRED
      • FAILED
    • updatedAt
      Type: string Format: date-time

      Last update timestamp

  • page
    Type: integer Format: int32

    Page index (0-based)

  • size
    Type: integer Format: int32

    Page size

  • totalElements
    Type: integer Format: int64

    Total number of items across all pages

  • totalPages
    Type: integer Format: int32

    Total number of pages