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

    • calendario
      Type: object · CalendarDueDateResponseDTO

      Calendar information for charge with due date (COBV) response

    • chave
      Type: string

      Pix key of the receiver

    • createdAt
      Type: string Format: date-time

      Creation timestamp

    • devedor
      Type: object · DebtorResponseDTO

      Debtor (payer) information in the response

    • id
      Type: string

      Unique identifier of the charge

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

      Additional information list for the payer

      Additional information for the payer

    • loc
      Type: object · LocationBindResponseDTO

      Location information in the charge response

    • pix
      Type: array object[] · PixPaymentDTO[]

      List of Pix payments received for this charge. Only present when at least one payment has been made.

      Pix payment information for a charge (COBV)

    • pixCopiaECola
      Type: string

      Pix payload (BR Code) containing only the Location URL

    • qrCodeImage
      Type: object · QrCodeImage

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

    • recebedor
      Type: object · MerchantDataResponseDTO

      Merchant (receiver) information in the response

    • revisao
      Type: integer Format: int32

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

    • solicitacaoPagador
      Type: string

      Optional message/request for the payer

    • status
      Type: string enum

      Status of a dynamic charge

      values
      • ATIVA
      • CONCLUIDA
      • REMOVIDA_PELO_USUARIO_RECEBEDOR
      • REMOVIDA_PELO_PSP
    • txid
      Type: string

      Transaction identifier

    • type
      Type: string enum

      Type of QR Code

      values
      • STATIC
      • DYNAMIC
      • DYNAMIC_DUE_DATE
      • UNKNOWN
    • valor
      Type: object · AmountDueDateResponseDTO

      Amount information for charge with due date (COBV) response

  • 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