OffsetPageResultEntryResponse

Paginated result using offset-based pagination

  • hasNext
    Type: boolean

    Indicates whether a next page exists

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

    List of records returned on the current page

    Pix key entry details returned after creation, update, deletion, or retrieval

    • account
      Type: object · AccountResponse

      Linked transactional account information in response

    • createdAt
      Type: string Format: date-time

      Date when this record was created in PSTI

    • creationDate
      Type: string Format: date-time

      Date when the Pix key was originally created in DICT

    • endToEndId
      Type: string

      End-to-end identifier generated for this DICT lookup

    • id
      Type: string

      Internal identifier of the Pix key entry in PSTI

    • key
      Type: string

      Pix key value (may be normalized)

    • keyOwnershipDate
      Type: string Format: date-time

      Date when the current owner took ownership of the key

    • keyStatistics
      Type: object · KeyStatisticsDTO
    • keyType
      Type: string enum

      Type of the Pix key

      values
      • EVP
      • CPF
      • CNPJ
      • PHONE
      • EMAIL
    • openClaimCreationDate
      Type: string Format: date-time

      Date when an open portability/ownership claim was created for this key

    • owner
      Type: object · OwnerResponse

      Key holder (owner) information in response

    • ownerStatistics
      Type: object · OwnerStatisticsDTO

      Statistics about the key owner (returned when includeStatistics=true)

    • reason
      Type: string enum

      Reason for the key operation (creation, update, or deletion)

      values
      • USER_REQUESTED
      • RECONCILIATION
      • ACCOUNT_CLOSURE
      • BRANCH_TRANSFER
      • FRAUD
      • DEFAULT_OPERATION
      • RFB_VALIDATION
    • status
      Type: string enum

      Current status of the Pix key entry

      values
      • ACTIVE
      • INACTIVE
      • OPEN
      • WAITING_RESOLUTION
      • CONFIRMED
      • CANCELLED
      • COMPLETED
    • updatedAt
      Type: string Format: date-time

      Date of the last update to this record in PSTI

  • 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