extraProperties
required |
object
|
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
name
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
concurrencyStamp
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
tenantId
required |
string (uuid)
|
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
merchantId
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isActive
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
title
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
bannerImage
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
hideBanner
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
supportRetail
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
usePostOnSubmit
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
useCaptcha
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
supportTokenization
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
pageActions
required |
HostedPaymentPageActionUrls
HostedPaymentPageActionUrls |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
donations
required |
HostedPageDonations
HostedPageDonations |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
theme
required |
HostedPageTheme
HostedPageTheme |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
fieldsAndPanels
required |
HostedPageFieldsAndPanels
HostedPageFieldsAndPanels |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
receiptAndNotifications
required |
HostedPageReceipts
HostedPageReceipts |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
disclosures
required |
HostedPageDisclosures
HostedPageDisclosures |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
customText
required |
HostedPageCustomText
HostedPageCustomText |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
entityVersion
required |
integer (int32)
|
read only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isTemplate
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
templateName
required |
string
|
Deprecated. The name of the template saved from this page, echoed from the shared template
store; `null` when `isTemplate` is `false`.
nullabledeprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
templateDescription
required |
string
|
Deprecated. The description of the template saved from this page, echoed from the shared
template store; `null` when `isTemplate` is `false`.
nullabledeprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
shareTemplate
required |
boolean
|
Deprecated. Whether the template saved from this page is shared beyond its merchant, echoed
from the shared template store's published state.
deprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
createdFromTemplateId
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
pageMode
required |
HostedPaymentPageMode
HostedPaymentPageMode |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
collectPhone
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowPromoCodes
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
collectTaxId
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
savePaymentDetails
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
declineRetryMode
required |
HppDeclineRetryMode
HppDeclineRetryMode |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
termsUrl
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
callToActionText
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
productName
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
productDescription
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
productImageBlobName
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
fixedAmount
required |
number (double)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowCustomAmount
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
successRedirectUrl
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
successRedirectDelaySeconds
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
paymentMethods
required |
array of string
array of |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
customFieldNames
required |
array of string
array of |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
resolvedCustomFields
required |
array of HppResolvedCustomFieldDto
array of HppResolvedCustomFieldDto |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowedEmbeddingDomains
required |
array of string
array of |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
checkoutLayout
required |
CheckoutLayout
CheckoutLayout |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
pagePurpose
required |
HppPagePurpose
HppPagePurpose |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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
required |
HppRecurringPlan
HppRecurringPlan |
The inlined recurring-schedule definition whose first payment a
`SaveCardWithInitialCharge` page charges. `null` for every
other purpose.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
captureMode
required |
HppCaptureMode
HppCaptureMode |
Capture timing for the chargeable Payment flow. `null` resolves to
`Sale`.
`Authorize` produces an Authorization with capture deferred.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowDeveloperPortalEmbedding
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
hideTitle
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
hideMerchantName
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
hideLoadingIndicator
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
campaignId
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
products
required |
array of HppPageProduct
array of HppPageProduct |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isLocked
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lockedAt
required |
string (date-time)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lockedByUserId
required |
string (uuid)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lockedByUserName
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lockReason
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|