Page Metadata

Contains the opaque identifier, `nextOffset`, to indicate a paginated result set.

Financial DataOpen BankingOpen FinanceFinancial Data ExchangeConsumer PermissionedAccount DataTransactionsInvestmentsInsuranceTax DataPayrollRESTOAuth2FAPICFPB 1033

Properties

Name	Type	Description
nextOffset	string	Opaque cursor used by the provider to send the next set of records. Deprecated in favor of PageKeyQuery, will be removed with a future major release
nextPageKey	string	Opaque identifier. Does not need to be numeric or have any specific pattern. Implementation specific
totalElements	integer	Total number of elements

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Page Metadata",
  "description": "Contains the opaque identifier, `nextOffset`, to indicate a paginated result set.\n",
  "type": "object",
  "properties": {
    "nextOffset": {
      "type": "string",
      "example": "B47D80MVP23T",
      "description": "Opaque cursor used by the provider to send the next set of records.\nDeprecated in favor of PageKeyQuery, will be removed with a future major release\n"
    },
    "nextPageKey": {
      "type": "string",
      "example": "B47D80MVP23T",
      "description": "Opaque identifier. Does not need to be numeric or have any specific pattern.\nImplementation specific\n"
    },
    "totalElements": {
      "type": "integer",
      "example": 3,
      "description": "Total number of elements\n"
    }
  }
}