OffsetPageResultPortabilityClaimResponse

Paginated result using offset-based pagination

  • hasNext
    Type: boolean

    Indicates whether a next page exists

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

    List of records returned on the current page

    Portability claim response

    • acknowledgedAt
      Type: string Format: date-time

      Date and time the claim was acknowledged

    • cancelledAt
      Type: string Format: date-time

      Date and time the claim was cancelled

    • cancelledBy
      Type: string enum

      Party that cancelled the claim (present only if the claim was cancelled)

      values
      • DONOR
      • CLAIMER
      • SYSTEM
    • cancelReason
      Type: string enum

      Reason for cancellation (present only if the claim was cancelled)

      values
      • USER_REQUESTED
      • ACCOUNT_CLOSURE
      • FRAUD
      • DEFAULT_OPERATION
      • RECONCILIATION
      • RFB_VALIDATION
    • claimer
      Type: object · ClaimerDataResponse

      Claimant identification information in response

    • claimerAccount
      Type: object · ClaimerAccountDataResponse

      Claimant account information in response

    • claimerParticipant
      Type: string

      ISPB of the claimer (requesting) institution

    • closingPeriodEnd
      Type: string Format: date-time

      Deadline for closing the ownership claim (OWNERSHIP type only)

    • completedAt
      Type: string Format: date-time

      Date and time the claim was completed

    • completedBy
      Type: string enum

      Party that completed the claim (present only if the claim was completed)

      values
      • CLAIMER
      • SYSTEM
    • completionPeriodEnd
      Type: string Format: date-time

      Deadline for the claimer to complete the claim after confirmation

    • confirmedAt
      Type: string Format: date-time

      Date and time the claim was confirmed

    • confirmedBy
      Type: string enum

      Party that confirmed the claim (present only if the claim was confirmed)

      values
      • DONOR
      • SYSTEM
    • dictClaimId
      Type: string Format: uuid

      Claim identifier in DICT

    • donorParticipant
      Type: string

      ISPB of the donor (current holder) institution

    • expiresAt
      Type: string Format: date-time

      Expiration date of the claim (OWNERSHIP type only)

    • id
      Type: string Format: uuid

      Internal claim identifier in PSTI

    • isClaimer
      Type: boolean

      Indicates whether the requesting participant is the claimer institution

    • isDonor
      Type: boolean

      Indicates whether the requesting participant is the donor institution

    • key
      Type: string

      Pix key value being claimed

    • keyType
      Type: string enum

      Type of the Pix key being claimed

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

      Date and time of the last status change

    • requestedAt
      Type: string Format: date-time

      Date and time the claim was opened in DICT (request date)

    • resolutionPeriodEnd
      Type: string Format: date-time

      Deadline for the donor to confirm or cancel the claim

    • status
      Type: string enum

      Current status of the claim

      values
      • OPEN
      • WAITING_RESOLUTION
      • CONFIRMED
      • CANCELLED
      • COMPLETED
    • type
      Type: string enum

      Claim type: PORTABILITY or OWNERSHIP

      values
      • PORTABILITY
      • OWNERSHIP
  • 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