OffsetPageResultChargeDueDateResponseDTO

Paginated result using offset-based pagination

  • hasNext
    Type: boolean

    Indicates whether a next page exists

  • items
    Type: array object[] · ChargeDueDateResponseDTO[]

    List of records returned on the current page

    Response for dynamic charge with due date (COBV) creation

    • additionalInfo
      Type: array object[] · AdditionalInfoDTO[]

      Additional information list for the payer

      Additional information for the payer

    • amount
      Type: object · AmountDueDateResponseDTO

      Amount information for charge with due date (COBV) response

    • brCode
      Type: string

      Pix payload (BR Code) containing only the Location URL

    • calendar
      Type: object · CalendarDueDateResponseDTO

      Calendar information for charge with due date (COBV) response

    • createdAt
      Type: string Format: date-time

      Creation timestamp

    • id
      Type: string

      Unique identifier of the charge

    • key
      Type: string

      Pix key of the receiver

    • location
      Type: object · LocationBindResponseDTO

      Location information in the charge response

    • merchant
      Type: object · MerchantDataResponseDTO

      Merchant (receiver) information in the response

    • payerRequest
      Type: string

      Optional message/request for the payer

    • qrCodeImage
      Type: object · QrCodeImage

      QR Code image data. Returned only if 'emitImage=true' in the request.

    • revision
      Type: integer Format: int32

      Revision number of the charge. Starts at 0 on creation.

    • status
      Type: string enum

      Status of a dynamic charge

      values
      • ACTIVE
      • COMPLETED
      • EXPIRED
      • REMOVED_BY_RECEIVER
      • REMOVED_BY_PSP
    • txid
      Type: string

      Transaction identifier

    • type
      Type: string enum

      Type of QR Code

      values
      • STATIC
      • DYNAMIC
      • DYNAMIC_DUE_DATE
      • UNKNOWN
  • page
    Type: integer Format: int32

    Current page number (zero-based)

  • size
    Type: integer Format: int32

    Number of records per page

  • totalItems
    Type: integer Format: int64

    Total number of records matching the query

  • totalPages
    Type: integer Format: int32

    Total number of pages available