HostedPageFieldsAndPanels
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents the configuration of fields and panels for the hosted payment page, including display options and custom labels.
Values
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.
Fields
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
fieldInvoice
required |
HppFieldVisibility HppFieldVisibility | Gets or sets a value indicating whether to display the invoice number field.
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.
| ||||||
fieldTax
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the tax amount field.
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.
| ||||||
fieldConvenienceFee
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the convenience fee field.
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.
| ||||||
fieldShipping
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the shipping amount field.
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.
| ||||||
fieldTotal
required |
boolean | Gets or sets a value indicating whether to display the total amount field.
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.
| ||||||
fieldBillingAddr
required |
HppFieldVisibility HppFieldVisibility | Gets or sets a value indicating whether to display the billing address fields.
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.
| ||||||
fieldShipAddr
required |
HppFieldVisibility HppFieldVisibility | Gets or sets a value indicating whether to display the shipping address fields.
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.
| ||||||
panelWidthOrder
required |
integer (int32) | Gets or sets an optional width for the order detail panel.
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.
| ||||||
panelWidthCustom
required |
integer (int32) | Gets or sets an optional width for the custom fields panel.
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.
| ||||||
panelWidthAddress
required |
integer (int32) | Gets or sets an optional width for the address panels.
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.
| ||||||
panelWidthCard
required |
integer (int32) | Gets or sets an optional width for the card detail panel.
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.
| ||||||
amountSetByCustomer
required |
boolean | Gets or sets a value indicating whether the total amount can be set by the customer.
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.
| ||||||
panelWidthResult
required |
integer (int32) | Gets or sets an optional width for the result panel.
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.
| ||||||
customerSetsInvoiceNumber
required |
boolean | Gets or sets a value indicating whether the customer can set the invoice number.
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.
| ||||||
fieldCustomerEmail
required |
HppFieldVisibility HppFieldVisibility | Gets or sets a value indicating whether to display the customer email field.
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.
| ||||||
fieldCustomerNameOnCard
required |
HppFieldVisibility HppFieldVisibility | Gets or sets a value indicating whether to display the customer Name on card.
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.
| ||||||
hideHeaderMenu
required |
boolean | Gets or sets a value indicating whether to hide the header menu/panel.
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.
| ||||||
orderPanelCustomText
required |
string | Gets or sets an optional custom label for the order panel.
nullablemax length 125
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.
| ||||||
customizeOrderPanelText
required |
boolean | Gets or sets a value indicating whether to replace the default order panel label with a custom label.
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.
| ||||||
customFieldPanelCustomText
required |
string | Gets or sets an optional custom label for the custom field panel.
nullablemax length 125
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.
| ||||||
customizeCustomFieldPanelText
required |
boolean | Gets or sets a value indicating whether to replace the default custom field panel label with a custom label.
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.
| ||||||
addressPanelCustomText
required |
string | Gets or sets an optional custom label for the address panel.
nullablemax length 125
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.
| ||||||
customizeAddressPanelText
required |
boolean | Gets or sets a value indicating whether to replace the default address panel label with a custom label.
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.
| ||||||
cardPanelCustomText
required |
string | Gets or sets an optional custom label for the card detail panel.
nullablemax length 125
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.
| ||||||
customizeCardPanelText
required |
boolean | Gets or sets a value indicating whether to replace the default card panel label with a custom label.
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.
| ||||||
resultPanelCustomText
required |
string | Gets or sets an optional custom label for the result panel.
nullablemax length 125
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.
| ||||||
customizeResultPanelText
required |
boolean | Gets or sets a value indicating whether to replace the default result panel label with a custom label.
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.
| ||||||
showOrderPanelText
required |
boolean | Gets or sets a value indicating whether to display header label for the order panel.
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.
| ||||||
showCustomFieldsText
required |
boolean | Gets or sets a value indicating whether to display the header label for the custom fields panel.
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.
| ||||||
showAddressPanelText
required |
boolean | Gets or sets a value indicating whether to display the header label for the address panel.
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.
| ||||||
showCardPanelText
required |
boolean | Gets or sets a value indicating whether to display the header label for the card detail panel.
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.
| ||||||
showResultPanelText
required |
boolean | Gets or sets a value indicating whether to display the header label for the result panel.
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.
| ||||||
hideAddressAndPhone
required |
boolean | Gets or sets a value indicating whether to hide the address and phone number fields.
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.
| ||||||
fieldTip
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the tip amount field. `null` is treated as
`Hidden`.
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.
| ||||||
fieldPurchaseOrder
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the customer code / purchase order field. `null` is
treated as `Hidden`.
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.
| ||||||
fieldContactPhone
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the contact phone field. `null` means the page has never
configured it and the older control decides: the Streamlined `CollectPhone` toggle, or
on a Classic page the always-rendered phone input behind `hideAddressAndPhone`.
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.
| ||||||
fieldLevel3Amount
required |
HppFieldVisibility HppFieldVisibility | Gets or sets the visibility of the read-only Level 3 summary a session can carry.
`null` means the page has never configured it and the older
`AllowLevel3LineItems` toggle decides.
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.
| ||||||
shippingAmountMode
required |
HppShippingAmountMode HppShippingAmountMode | Gets or sets where this page's shipping amount comes from. `null` is treated as
`CardholderEntered`.
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.
| ||||||
flatShippingAmount
required |
number (double) | Gets or sets the fixed shipping amount this page charges. Meaningful only in
`Flat` mode; the save-time validator refuses a non-null value
in any other mode so a stale amount cannot sit in the document waiting to be reactivated by a
later mode change.
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.
| ||||||
shippingQuoteFailureBehavior
required |
HppShippingQuoteFailureBehavior HppShippingQuoteFailureBehavior | Gets or sets what a `ProviderCalculated` page does when no
carrier rate can be quoted. `null` is treated as
`BlockPayment`.
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.
| ||||||
shippingFallbackAmount
required |
number (double) | Gets or sets the shipping amount, in the transaction currency, that a
`ProviderCalculated` page charges when no carrier rate can be
quoted and the page is set to `ChargeFallbackAmount`.
Zero is a valid configured value.
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.
| ||||||
taxAmountMode
required |
HppTaxAmountMode HppTaxAmountMode | Gets or sets where this page's tax amount comes from. `null` is treated as
`CardholderEntered`.
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.
| ||||||
flatTaxRateId
required |
string (uuid) | Gets or sets the identifier of the merchant's invoicing tax rate this page charges. Meaningful
only in `FlatRate` mode; the save-time validator refuses a non-null
value in any other mode so a stale rate cannot be reactivated by a later mode change.
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.
| ||||||
taxQuoteAddress
required |
HppTaxQuoteAddress HppTaxQuoteAddress | Gets or sets which of the customer's addresses a
`ProviderCalculated` page looks the tax rate up for. `null` is
treated as `Billing`. The save-time validator refuses a non-null
value in any other mode.
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.
| ||||||
panelLayout
required |
array of HppPanelDefinition array of HppPanelDefinition | Optional explicit panel ordering and sizing for the public form. When `null`, the page
uses the default panel layout.
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.
| ||||||
Fields of each HppPanelDefinition: This body has no documented fields. | ||||||||
This model has no documented fields.