# ContinuationPagedResultDtoOfHostedPaymentPageDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Represents a page of results obtained through continuation-token paging.
Supports an approximate total count for display purposes.

## Fields
- `items` (array<[HostedPaymentPageDto](https://devportal.demo.winkpg.io/docs/api/models/HostedPaymentPageDto.md)>): The items returned for this page. (nullable)
  Fields of each item:
  - `extraProperties` (object): (nullable, read only)
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `name` (string): (nullable)
  - `concurrencyStamp` (string): (nullable)
  - `tenantId` (string(uuid)): (nullable, read only)
  - `merchantId` (string(uuid))
  - `isActive` (boolean)
  - `title` (string): (nullable)
  - `bannerImage` (string): Filename of the header banner image, as produced by the portal image uploader. This is not a  URL: the public page resolves the filename against the hosted-page image CDN container. See  `bannerImage` for the write contract. (nullable)
  - `hideBanner` (boolean)
  - `supportRetail` (boolean)
  - `usePostOnSubmit` (boolean)
  - `useCaptcha` (boolean)
  - `supportTokenization` (boolean)
  - `pageActions` ([HostedPaymentPageActionUrls](https://devportal.demo.winkpg.io/docs/api/models/HostedPaymentPageActionUrls.md))
  - `donations` ([HostedPageDonations](https://devportal.demo.winkpg.io/docs/api/models/HostedPageDonations.md))
  - `theme` ([HostedPageTheme](https://devportal.demo.winkpg.io/docs/api/models/HostedPageTheme.md))
  - `fieldsAndPanels` ([HostedPageFieldsAndPanels](https://devportal.demo.winkpg.io/docs/api/models/HostedPageFieldsAndPanels.md))
  - `receiptAndNotifications` ([HostedPageReceipts](https://devportal.demo.winkpg.io/docs/api/models/HostedPageReceipts.md))
  - `disclosures` ([HostedPageDisclosures](https://devportal.demo.winkpg.io/docs/api/models/HostedPageDisclosures.md))
  - `customText` ([HostedPageCustomText](https://devportal.demo.winkpg.io/docs/api/models/HostedPageCustomText.md))
  - `entityVersion` (integer(int32)): (read only)
  - `isTemplate` (boolean): Deprecated. `true` when a template has been saved from this page. Templates live in the  shared template store; this echoes whether a store row exists for the page (or, for a page  written under the former inline model that has not been migrated yet, its stored flag). (deprecated)
  - `templateName` (string): Deprecated. The name of the template saved from this page, echoed from the shared template  store; `null` when `isTemplate` is `false`. (nullable, deprecated)
  - `templateDescription` (string): Deprecated. The description of the template saved from this page, echoed from the shared  template store; `null` when `isTemplate` is `false`. (nullable, deprecated)
  - `shareTemplate` (boolean): Deprecated. Whether the template saved from this page is shared beyond its merchant, echoed  from the shared template store's published state. (deprecated)
  - `createdFromTemplateId` (string(uuid)): The template this page was created from, or `null` for a page started blank. Set by the  create-from-template paths and by the designers' Load Template action when the page is saved. (nullable)
  - `pageMode` ([HostedPaymentPageMode](https://devportal.demo.winkpg.io/docs/api/models/HostedPaymentPageMode.md)): (nullable)
    Values:
    - `Classic`: The original full-control builder with accordion sections and comprehensive configuration.
    - `Streamlined`: A simplified, Stripe-inspired builder with live preview and a clean two-column public form.
  - `collectBusinessName` (boolean): (nullable)
  - `collectPhone` (boolean): Older Streamlined control for the payer phone field. Honored only while  `fieldsAndPanels.fieldContactPhone` is `null`; once that visibility is set it decides  what the page renders, and this toggle is kept in step with it on every save. (nullable)
  - `allowPromoCodes` (boolean): (nullable)
  - `collectTaxId` (boolean): Deprecated and inert. No hosted payment page renders a tax ID field, so setting this collects  nothing and no tax ID is stored. To capture a buyer tax ID, define a merchant custom field and  make it visible on hosted payment pages. (nullable)
  - `savePaymentDetails` (boolean): (nullable)
  - `declineRetryMode` ([HppDeclineRetryMode](https://devportal.demo.winkpg.io/docs/api/models/HppDeclineRetryMode.md)): What a payment link created against this page does when a payment is declined. `null`  inherits the tenant default, which is the historical single-use behavior: any declined  payment spends the link permanently. (nullable)
    Values:
    - `ConsumeOnDecline`: The historical behavior, and the default at every level of the resolution chain. Any processor answer spends the link permanently: the session stays Consumed and a payer who reloads it is told the link has already been used.
    - `ReleaseOnDecline`: A definite issuer decline hands the link back to Pending so the payer can correct their card and resubmit on the same URL, instead of having to ask the merchant for a new link.
  - `requireTermsAcceptance` (boolean): (nullable)
  - `termsUrl` (string): (nullable)
  - `callToActionText` (string): (nullable)
  - `productName` (string): (nullable)
  - `productDescription` (string): (nullable)
  - `productImageBlobName` (string): Filename of the Streamlined order-summary product image, as produced by the portal image  uploader. This is not a URL: the public page resolves the filename against the hosted-page  image CDN container. See  `productImageBlobName` for the write  contract. (nullable)
  - `fixedAmount` (number(double)): (nullable)
  - `allowCustomAmount` (boolean): (nullable)
  - `successRedirectUrl` (string): (nullable)
  - `successRedirectDelaySeconds` (integer(int32)): Seconds the hosted confirmation panel is shown before the payer is sent to the configured  post-payment address. `null` means the page inherits the platform-configured  delay. See `successRedirectDelaySeconds`  for the write contract. (nullable)
  - `paymentMethods` (array<string>): (nullable)
  - `customFieldNames` (array<string>): Optional per-page allow-list of merchant custom-field names this page shows and accepts.  `null` means "all of the merchant's HPP-visible custom fields"; an explicit empty list  means "no merchant custom fields on this page". See  `customFieldNames` for the full-replace semantics. (nullable)
  - `resolvedCustomFields` (array<[HppResolvedCustomFieldDto](https://devportal.demo.winkpg.io/docs/api/models/HppResolvedCustomFieldDto.md)>): The merchant custom fields this page actually shows and accepts, in the order it renders them.  Read-only, and resolved on every page the hosted-payment-pages API returns:  `customFieldNames` is only the page's selection,  and its default (`null`) means "all of the merchant's hosted-page custom fields", so the  selection on its own does not tell a caller what the page uses. This resolves it against the  merchant's current definitions, applying the same enabled / hosted-page-visible / page-purpose  gates the page itself applies, and reports each field's validation rules so a value can be checked  before it is posted.     The list also carries the fields the merchant keeps hidden from the payer but opted in to  accepting a value for through the session API, flagged by  `isRenderedToPayer`. Those are reported precisely because  the API is the only way to use them.       Empty means the page uses no merchant custom fields. Definitions are merchant-global and live, so  this tracks the merchant's configuration: renaming or disabling a field changes what this returns  for every page that had not scoped itself to a fixed list. Sending it back on a create or update  has no effect; the write contract is `customFieldNames`. (nullable)
  - `allowedEmbeddingDomains` (array<string>): (nullable)
  - `checkoutLayout` ([CheckoutLayout](https://devportal.demo.winkpg.io/docs/api/models/CheckoutLayout.md)): (nullable)
    Values:
    - `Standard`: Two-column layout: order summary on the left, payment form on the right. This is the default layout matching the original Streamlined mode design.
    - `Compact`: Single centered column with an inline summary at the top, form fields below, and a prominent CTA button. Minimal chrome, max-width ~480px.
    - `Split`: Full-width hero header with product image and summary information, then a centered narrower column (~560px) with the payment form below.
    - `Embedded`: Frameless minimal layout designed for iframe embedding. No order summary panel, just payment fields and CTA with minimal padding.
  - `allowLevel3LineItems` (boolean): Older control for the read-only Level 3 line-item summary. Honored only while  `fieldsAndPanels.fieldLevel3Amount` is `null`; once that visibility is set it decides  what the page renders, and this toggle is kept in step with it on every save. (nullable)
  - `pagePurpose` ([HppPagePurpose](https://devportal.demo.winkpg.io/docs/api/models/HppPagePurpose.md)): Instance-level page purpose. `null` resolves to `Payment`.  `SaveCard` dedicates the page  to capturing and storing the customer's card via a zero-dollar verification (no charge);  amount-bearing configuration is hidden in the builder and rejected by the validator, and  sessions created against the page inherit the save-card flow. (nullable)
    Values:
    - `Payment`: The default, historical behavior: a chargeable payment page. null resolves here, so every pre-existing HPP instance keeps behaving exactly as before.
    - `SaveCard`: A card-capture page: the cardholder's card is validated via a zero-dollar account verification (authorize $0 + AVS/CVV, immediate void), then vaulted with stored-credential consent. No charge is taken. Amount-bearing configuration (tax, shipping, convenience fee, invoice amounts, donations, tip) is irrelevant and is hidden in the builder / rejected by the validator. Requires the merchant's processor to advertise SupportsZeroDollarVerification.
    - `SaveCardWithInitialCharge`: A card-capture page that also charges the first of a recurring schedule. The cardholder's card is charged a real initial sale (the first payment of a referenced reusable recurring plan, framed as the customer-initiated transaction that establishes the credential-on-file agreement), vaulted with Recurring stored-credential consent, and a customer Contract is created for the remaining payments. Like SaveCard, the amount-bearing builder configuration (tax, shipping, convenience, invoice, donations, tip, customer-set amount) is hidden: the charged amount is driven entirely by the inlined recurring definition, not by per-page amount fields. Requires a complete inlined recurring definition (RecurringPlan).
  - `recurringPlan` ([HppRecurringPlan](https://devportal.demo.winkpg.io/docs/api/models/HppRecurringPlan.md)): The inlined recurring-schedule definition whose first payment a  `SaveCardWithInitialCharge` page charges. `null` for every  other purpose.
  - `captureMode` ([HppCaptureMode](https://devportal.demo.winkpg.io/docs/api/models/HppCaptureMode.md)): Capture timing for the chargeable Payment flow. `null` resolves to  `Sale`.  `Authorize` produces an Authorization with capture deferred. (nullable)
    Values:
    - `Sale`: Authorize and capture funds in a single step (the historical, default behavior). null resolves here, so every pre-existing chargeable page keeps doing an implicit Sale.
    - `Authorize`: Authorize now, capture later (delayed capture). The resulting transaction is an Authorization in an Authorized state, eligible for capture and void per the action matrix; the capture is completed later against the resulting transaction id via the existing capture action path (including the Apple Pay single-use token case).
  - `allowTransparentEmbedding` (boolean): Opt-in to a see-through backdrop when the page is rendered inside a merchant iframe.  `null`/`false` keeps the page opaque (the default). Honoured only when the request is genuinely framed and  `allowedEmbeddingDomains` is configured. (nullable)
  - `allowDeveloperPortalEmbedding` (boolean): Whether the developer portal's public origin is allowed to embed this page, in addition to  `allowedEmbeddingDomains`. `null`/`false` is off (the default). (nullable)
  - `hideTitle` (boolean): Suppress the page `title` on the payer-facing page (both the Classic and the  Streamlined renderer). `null`/`false` is the default and renders the title exactly as  before. Display-only: the title is still stored, still returned, and still shown on the  administrative surfaces (grid, quick view, favorites subtitle). (nullable)
  - `hideMerchantName` (boolean): Suppress the merchant business-name line in the Streamlined identity header on the payer-facing  page. `null`/`false` is the default. The banner image in that same header stays  governed by `hideBanner`.     Display-only, and deliberately narrow: the merchant name still reaches the Apple Pay / Paze sheet  total label and the NACHA ACH consent copy (and the consent evidence captured with an ACH  authorization), which must name the real merchant regardless of this flag. (nullable)
  - `hideLoadingIndicator` (boolean): Suppress the gateway's own loading chrome on the payer-facing page: the loading card shown  while the page resolves, and the connecting affordance drawn over the prerendered form before  the circuit is live. `null`/`false` is the default and shows them exactly as before.     For an integrator who embeds the page and paints a loading state of their own, revealing the  frame on the `ready` event. Display-only: the session, the payment and the events the  page emits are untouched. Honored on the initial document, which the embedding-restriction  feature resolves the page for; a deployment with that feature off shows the chrome as before. (nullable)
  - `campaignId` (string(uuid)): Optional campaign this page belongs to. Sessions created from this page inherit it when the  create request names no campaign of its own, so a merchant can attach a whole page to a  campaign once instead of naming it on every link. (nullable)
  - `products` (array<[HppPageProduct](https://devportal.demo.winkpg.io/docs/api/models/HppPageProduct.md)>): The catalog products this page sells, in display order, or `null` for a page priced by a  single `productName` with a `fixedAmount` or a payer-entered amount.  Each entry references an invoicing catalog product owned by this page's merchant; the price,  name and quantity limits are read from the catalog when a link is created and snapshotted onto  that link, so editing the catalog never reprices a link already in a payer's hands. (nullable)
  - `isLocked` (boolean): (nullable)
  - `lockedAt` (string(date-time)): (nullable)
  - `lockedByUserId` (string(uuid)): (nullable)
  - `lockedByUserName` (string): (nullable)
  - `lockReason` (string): (nullable)
- `nextContinuationToken` (string): Continuation token to use when requesting the next page.  Null means no additional pages exist. (nullable)
- `approxTotalCount` (integer(int64)): An approximate total count of matching items.  This value is optional and may be stale or estimated, so treat it as an approximation. (nullable)
- `pageItemCount` (integer(int32)): Convenience property for the number of items in this page. (read only)
- `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior.

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.