PaymentInstructionPageResponseDTO

Paginated response of payment instructions.

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

    Items in the current page

    Full state of a payment instruction (a single charge within an active mandate).

    • acceptedAt
      Type: string Format: date-time

      Timestamp the instruction became ACCEPTED (after pain.014 ACSP)

    • amount
      Type: number

      Amount to collect (BRL)

    • cancellationId
      Type: string

      BACEN cancellation id (returned in camt.029)

    • cancellationReason
      Type: string

      BACEN cancellation reason code

    • cancelledAt
      Type: string Format: date-time

      Timestamp of cancellation

    • cancelledBy
      Type: string enum

      Who cancelled the instruction

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

      Record creation timestamp

    • description
      Type: string

      Free-text description from the receiver

    • endToEndId
      Type: string

      End-to-end identifier (BACEN format E + ISPB + timestamp + random)

    • expiryDate
      Type: string Format: date

      Last day the user can approve the charge before it expires

    • localInstrument
      Type: string

      BACEN local instrument (always AUTO for Pix Automatico)

    • mandateId
      Type: string

      Parent mandate id this charge belongs to

    • purpose
      Type: string enum

      Purpose of the automatic Pix payment (SPI purpose codes)

      values
      • AUTO
      • GSCB
      • IPAY
      • IPRT
      • OTHR
      • REFU
    • receivedAt
      Type: string Format: date-time

      Timestamp the original pain.013 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

    • requestedExecutionDate
      Type: string Format: date-time

      When the charge should be executed

    • sender
      Type: object · SenderDTO2

      Payer/sender information

    • settledAt
      Type: string Format: date-time

      Timestamp of final settlement (after pacs.002)

    • status
      Type: string enum

      Current instruction status

      values
      • PENDING_USER_APPROVAL
      • APPROVAL_SENT
      • ACCEPTED
      • SETTLED
      • 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