Hosted Payment Page Field Reference

The Hosted Payment Page Field Reference explains each configuration option available when building or customizing a Hosted Payment Page. These settings control how the page looks, what information is collected from customers, and how the payment flow behaves. Use this glossary as a reference for understanding every section and field shown in the Hosted Payment Page editor.

General Settings

The General Settings section contains the core configuration values for a Hosted Payment Page. These settings control the identity of the page, its association to a merchant, and basic display options such as the title and banner branding. Some fields are informational only and cannot be edited.

General Settings Fields

FieldDescription
IDA system-generated unique identifier for the Hosted Payment Page. This value is read-only and used internally for referencing the page.
Merchant IDThe unique identifier of the merchant that owns the page. This value is read-only and determines which merchant account the Hosted Payment Page belongs to.
NameThe internal name for the Hosted Payment Page. This is not displayed to customers and is used only for managing pages within the portal.
TitleThe visible title displayed at the top of the Hosted Payment Page seen by customers.
Is ActiveEnables or disables the Hosted Payment Page. When disabled, the page cannot be accessed or used to process payments.
Banner ImageAn optional logo or header image shown at the top of the Hosted Payment Page. Merchants can upload or clear this image as needed.
Hide BannerHides the banner image from the Hosted Payment Page without deleting it from the configuration.

Page Actions

The Page Actions section defines optional redirect behaviors that occur after a customer interacts with the Hosted Payment Page. These settings allow merchants to control navigation after submitting a payment or after viewing the hosted receipt page, enabling seamless transitions back to their website or other custom destinations

Page Action Fields

FieldDescription
SubmitAn optional URL that the customer is redirected to immediately after submitting the Hosted Payment Page form. If left blank, the standard hosted receipt page is displayed.
EditAn optional URL used on the hosted receipt page to return the customer to the original payment page to make corrections or updates.
Continue URLAn optional URL used on the hosted receipt page that allows the customer to navigate to a different page after completing payment.

Donations

The Donations section allows merchants to enable optional contribution amounts on the Hosted Payment Page. When enabled, customers can choose from pre-defined donation amounts during checkout.

Donation Fields

FieldDescription
Enable Donation AmountsToggles donation functionality on the Hosted Payment Page. When enabled, customers can select from preset contribution amounts.
Donation AmountsA comma-separated list of donation values (for example 1, 2, 5.50). These amounts appear as selectable options for customers during checkout.

Theme

The Theme section controls the visual appearance of the Hosted Payment Page. These settings allow merchants to match the page’s styling to their brand by customizing colors, fonts, borders, and layout elements. All theme options affect only the presentation layer and do not modify payment behavior or functionality.

Note: All color values are entered in hex format (for example, #000000), and all font sizes are specified in pixels.

Theme Fields

FieldDescription
Back ColorSets the page background color for the hosted payment page.
FontThe font-family used for the main body text.
Font SizeThe size of the main body font.
Font ColorThe color used for the main body text.
Header Back ColorThe background color displayed behind header text.
Header Border ColorThe color used for the border around the header area.
Header FontThe font-family used for header text.
Header Font SizeThe size of the header text.
Header Font ColorThe color used for header text.
Panel Back ColorThe background color of the content panels on the page.
Panel Border ColorThe color used for panel borders.
Input Field Background ColorThe background color of form input fields in their normal state.
Input Field Border ColorThe border color used for form input fields.
Input Field Background Focus ColorThe background color of form input fields when selected or focused.
Input Field Font SizeThe size of the text displayed inside input fields.
Input Field Font ColorThe color of the text displayed inside input fields.
Button ColorThe fill/background color used for buttons.
Button Border ColorThe border color used for buttons.
Custom CSSOptional custom CSS that can be applied for advanced or brand-specific styling.

Fields and Panels

The Fields and Panels section allows merchants to control which input fields and information panels appear on the Hosted Payment Page. These settings include enabling or disabling specific fields (such as invoice, tax, shipping, or billing details) and customizing panel labels shown to the customer. This level of control helps merchants tailor the page to their business needs while keeping the checkout experience clear and efficient.

Fields and Panels Options

FieldDescription
Field InvoiceDisplays the invoice number field.
Field TaxDisplays the tax amount field.
Field ShippingDisplays the shipping amount field.
Field TotalDisplays the total amount field.
Field Billing AddrDisplays the billing address fields.
Field Ship AddrDisplays the shipping address fields.
Amount Set By CustomerAllows the customer to enter their own total amount.
Customer Sets Invoice NumberAllows the customer to enter the invoice number.
Field Customer EmailDisplays the customer email field.
Hide Header MenuHides the header menu/panel from the hosted payment page.
Order Panel Custom TextSets a custom label for the order details panel.
Customize Order Panel TextReplaces the default order panel header with custom text.
Address Panel Custom TextSets a custom label for the address panel.
Customize Address Panel TextReplaces the default address panel header with custom text.
Card Panel Custom TextSets a custom label for the card detail panel.
Customize Card Panel TextReplaces the default card panel header with custom text.
Result Panel Custom TextSets a custom label for the result panel.
Customize Result Panel TextReplaces the default result panel header with custom text.
Show Order Panel TextDisplays the header label for the order panel.
Show Address Panel TextDisplays the header label for the address panel.
Show Card Panel TextDisplays the header label for the card detail panel.
Show Result Panel TextDisplays the header label for the result panel.
Hide Address And PhoneHides both the address and phone number fields.

Receipt and Notifications

The Receipt and Notifications section controls how customers and merchants receive confirmations, emails, and webhook notifications after a Hosted Payment Page transaction is processed. These settings allow merchants to customize receipt content, upload logos, enable PDF receipts, and configure automated notifications for both customers and internal teams.

Receipt and Notifications Settings

FieldDescription
Callback URLAn optional URL to receive a webhook notification when a hosted payment page transaction is processed.
Customer Email LogoA logo image that appears on customer email receipts.
Customer Email FooterOptional footer text to include at the bottom of customer email receipts.
Customer Email BodyOptional body text to appear within customer email receipts.
Use Hosted ConfirmEnables the built-in hosted confirmation/receipt page. Disable this option to redirect customers to a custom confirmation page instead.
Receipt Additional TextOptional extra text to include on the customer receipt.
Customer Email as PDFSends customer receipts as PDF attachments instead of inline email content.
Email Purchase NotificationsSends notification emails to one or more email addresses whenever a transaction is completed via the hosted payment page.

Disclosures

The Disclosures section allows merchants to present important information—such as terms, conditions, policies, or legally required notices—to customers before they complete a transaction. These settings control whether the disclosure text appears and whether customer acceptance is required prior to submitting the payment.

Disclosure Settings

FieldDescription
Disclosure TextThe body text displayed to the customer as a disclosure before processing a transaction. This text can include terms of service, refund policies, consent language, or other informational notices.
Show DisclosuresEnables the display of the disclosure text on the Hosted Payment Page. When turned off, the disclosure text is hidden.
Require Disclosure AcceptRequires the customer to explicitly accept the disclosure before completing the transaction.

Custom Text

The Custom Text section allows merchants to personalize the wording, links, and messaging displayed on the Hosted Payment Page. These settings help tailor the page to match branding, provide additional context to customers, and supply links to important resources such as policies, terms, or support pages.

Custom Text Fields

FieldDescription
Terms and Conditions LinkAn optional URL for a linkto your terms and conditions page.
About Us LinkAn optional URL for a link to your “About Us” page.
Process Button TextOptional custom text to replace the default “Process” label on the payment submission button.
Header TextOptional text displayed at the top of the Hosted Payment Page.
Promo TextOptional text to display as a highlighted announcement, promotion, or special message near the top of the page.
Promo LinkAn optional URL that turns the promo text into a link.
Support LinkAn optional URL directing customers to a support page for assistance during payment submission.
Powered By TextOptional text to display a “powered by” caption at the bottom of the page.
Copyright TextOptional text used as a copyright notice.
Shipping Info LinkAn optional URL for more information on shipping policies and terms.
Privacy Policy LinkAn optional URL linking to your privacy policy page.