# POST /api/hostedpaymentpages

Create hosted payment page

Creates a new hosted payment page for customer checkout.

**Operation ID:** `POST_api_hostedpaymentpages`

## Authorization

Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Create, merchant scope.

Required permissions:
- `HostedPaymentPage.HostedPaymentPages`
- `HostedPaymentPage.HostedPaymentPages.Create`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: `PhoeniXGateHostedPaymentPageHostedPaymentPageCreateDto`

_Example: Classic Mode (full configuration)_

The original full-control hosted payment page builder with accordion-style configuration sections. Use this when you need fine-grained control over which fields are shown, theme/branding, donations, custom text, and disclosures.

```json
{
  "name": "Acme Online Checkout",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Pay Acme Corp",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": true,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "https://acme.example.com/checkout/submit",
      "enabled": true,
      "label": "Pay Now"
    },
    "edit": {
      "url": "https://acme.example.com/cart",
      "enabled": true,
      "label": "Edit Cart"
    },
    "continue": {
      "url": "https://acme.example.com/thank-you",
      "enabled": true,
      "label": "Continue"
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": "#ffffff",
    "panelBorderColor": "#e0e0e0",
    "buttonColor": "#0066cc",
    "buttonBorderColor": "#0066cc",
    "inputFieldBorderColor": "#cccccc",
    "inputFieldBackgroundColor": "#ffffff",
    "inputFieldFontSize": null,
    "inputFieldFontColor": "#333333",
    "inputFieldBackgroundFocusColor": "#f0f8ff",
    "backColor": "#fafafa",
    "fontColor": "#333333",
    "font": "Inter, sans-serif",
    "fontSize": null,
    "headerFont": "Inter, sans-serif",
    "headerFontColor": "#111111",
    "headerFontSize": null,
    "headerBackColor": "#ffffff",
    "headerBorderColor": "#e0e0e0",
    "customCSS": ""
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Required",
    "fieldTax": "Required",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Required",
    "fieldTotal": true,
    "fieldBillingAddr": "Required",
    "fieldShipAddr": "Required",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Summary",
    "customizeOrderPanelText": true,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": "Optional",
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": "https://acme.example.com/webhooks/hpp",
    "enableWebhookNotification": true,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": true,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": "By clicking Place Order you agree to Acme's Terms of Service.",
    "showDisclosures": true,
    "requireDisclosureAccept": true,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": "https://acme.example.com/terms",
    "aboutUsLink": null,
    "processButtonText": "Place Order",
    "headerText": "Secure Checkout",
    "promoText": null,
    "promoLink": null,
    "supportLink": "https://acme.example.com/support",
    "poweredByText": "Powered by Acme",
    "copyrightText": "© 2026 Acme Corp",
    "shippingInfoLink": null,
    "privacyPolicyLink": "https://acme.example.com/privacy"
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Classic",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": null,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": null,
  "productName": null,
  "productDescription": null,
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": null,
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": null,
  "allowLevel3LineItems": null,
  "pagePurpose": null,
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Streamlined Mode (Stripe-style)_

Simplified Stripe-inspired checkout with a clean two-column layout, fixed product, and minimum chrome. Designed to be embedded in an iframe on the merchant's site - configure AllowedEmbeddingDomains.

```json
{
  "name": "Annual Membership Checkout",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Annual Membership",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Hidden",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": false,
  "allowPromoCodes": true,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": true,
  "termsUrl": "https://acme.example.com/terms",
  "callToActionText": "Subscribe",
  "productName": "Annual Membership",
  "productDescription": "12 months of full access to all member benefits.",
  "productImageBlobName": null,
  "fixedAmount": 99,
  "allowCustomAmount": false,
  "successRedirectUrl": "https://acme.example.com/welcome",
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": [
    "acme.example.com",
    "*.acme.example.com"
  ],
  "checkoutLayout": "Standard",
  "allowLevel3LineItems": null,
  "pagePurpose": null,
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Save Card page (store a card, no charge)_

A dedicated card-capture page: the customer's card is validated with a zero-dollar account verification (authorize $0 with AVS/CVV, immediate void), vaulted as a reusable payment token, and stored-credential consent is captured. No charge is taken, so amount-bearing configuration (tax, tip, shipping, convenience fee, invoice amounts, donations) must stay hidden/off. Requires the merchant's processor to support zero-dollar verification.

```json
{
  "name": "Add Payment Method",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Save Your Card",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": "Save Card",
  "productName": "Card on File",
  "productDescription": "Securely save a card for future purchases. You will not be charged today.",
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": "Compact",
  "allowLevel3LineItems": null,
  "pagePurpose": "SaveCard",
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Save Card with Initial Charge (subscription enrollment)_

A card-capture page that also charges the first payment of an inlined recurring plan as a real sale, vaults the card with Recurring stored-credential consent, and creates a contract for the remaining payments. The charged amount comes entirely from the recurring plan, so the page's amount-bearing fields stay hidden. The plan needs complete economics: a positive recurring amount, an interval of at least 1, and at least two total payments; initialChargeAmount optionally overrides payment one (for example a bundled setup fee). The page must accept card only.

```json
{
  "name": "Gold Plan Enrollment",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Join the Gold Plan",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": "Enroll",
  "productName": "Gold Plan",
  "productDescription": "$49.99 today, then $29.99 per month for 11 more payments.",
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": "Standard",
  "allowLevel3LineItems": null,
  "pagePurpose": "SaveCardWithInitialCharge",
  "recurringPlan": {
    "recurringAmount": 29.99,
    "frequency": "Monthly",
    "interval": 1,
    "numberOfPayments": 12,
    "initialChargeAmount": 49.99
  },
  "captureMode": null
}
```

**Content type:** `text/json`

Schema: `PhoeniXGateHostedPaymentPageHostedPaymentPageCreateDto`

_Example: Classic Mode (full configuration)_

The original full-control hosted payment page builder with accordion-style configuration sections. Use this when you need fine-grained control over which fields are shown, theme/branding, donations, custom text, and disclosures.

```json
{
  "name": "Acme Online Checkout",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Pay Acme Corp",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": true,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "https://acme.example.com/checkout/submit",
      "enabled": true,
      "label": "Pay Now"
    },
    "edit": {
      "url": "https://acme.example.com/cart",
      "enabled": true,
      "label": "Edit Cart"
    },
    "continue": {
      "url": "https://acme.example.com/thank-you",
      "enabled": true,
      "label": "Continue"
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": "#ffffff",
    "panelBorderColor": "#e0e0e0",
    "buttonColor": "#0066cc",
    "buttonBorderColor": "#0066cc",
    "inputFieldBorderColor": "#cccccc",
    "inputFieldBackgroundColor": "#ffffff",
    "inputFieldFontSize": null,
    "inputFieldFontColor": "#333333",
    "inputFieldBackgroundFocusColor": "#f0f8ff",
    "backColor": "#fafafa",
    "fontColor": "#333333",
    "font": "Inter, sans-serif",
    "fontSize": null,
    "headerFont": "Inter, sans-serif",
    "headerFontColor": "#111111",
    "headerFontSize": null,
    "headerBackColor": "#ffffff",
    "headerBorderColor": "#e0e0e0",
    "customCSS": ""
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Required",
    "fieldTax": "Required",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Required",
    "fieldTotal": true,
    "fieldBillingAddr": "Required",
    "fieldShipAddr": "Required",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Summary",
    "customizeOrderPanelText": true,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": "Optional",
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": "https://acme.example.com/webhooks/hpp",
    "enableWebhookNotification": true,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": true,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": "By clicking Place Order you agree to Acme's Terms of Service.",
    "showDisclosures": true,
    "requireDisclosureAccept": true,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": "https://acme.example.com/terms",
    "aboutUsLink": null,
    "processButtonText": "Place Order",
    "headerText": "Secure Checkout",
    "promoText": null,
    "promoLink": null,
    "supportLink": "https://acme.example.com/support",
    "poweredByText": "Powered by Acme",
    "copyrightText": "© 2026 Acme Corp",
    "shippingInfoLink": null,
    "privacyPolicyLink": "https://acme.example.com/privacy"
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Classic",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": null,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": null,
  "productName": null,
  "productDescription": null,
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": null,
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": null,
  "allowLevel3LineItems": null,
  "pagePurpose": null,
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Streamlined Mode (Stripe-style)_

Simplified Stripe-inspired checkout with a clean two-column layout, fixed product, and minimum chrome. Designed to be embedded in an iframe on the merchant's site - configure AllowedEmbeddingDomains.

```json
{
  "name": "Annual Membership Checkout",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Annual Membership",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Hidden",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": false,
  "allowPromoCodes": true,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": true,
  "termsUrl": "https://acme.example.com/terms",
  "callToActionText": "Subscribe",
  "productName": "Annual Membership",
  "productDescription": "12 months of full access to all member benefits.",
  "productImageBlobName": null,
  "fixedAmount": 99,
  "allowCustomAmount": false,
  "successRedirectUrl": "https://acme.example.com/welcome",
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": [
    "acme.example.com",
    "*.acme.example.com"
  ],
  "checkoutLayout": "Standard",
  "allowLevel3LineItems": null,
  "pagePurpose": null,
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Save Card page (store a card, no charge)_

A dedicated card-capture page: the customer's card is validated with a zero-dollar account verification (authorize $0 with AVS/CVV, immediate void), vaulted as a reusable payment token, and stored-credential consent is captured. No charge is taken, so amount-bearing configuration (tax, tip, shipping, convenience fee, invoice amounts, donations) must stay hidden/off. Requires the merchant's processor to support zero-dollar verification.

```json
{
  "name": "Add Payment Method",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Save Your Card",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": "Save Card",
  "productName": "Card on File",
  "productDescription": "Securely save a card for future purchases. You will not be charged today.",
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": "Compact",
  "allowLevel3LineItems": null,
  "pagePurpose": "SaveCard",
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Save Card with Initial Charge (subscription enrollment)_

A card-capture page that also charges the first payment of an inlined recurring plan as a real sale, vaults the card with Recurring stored-credential consent, and creates a contract for the remaining payments. The charged amount comes entirely from the recurring plan, so the page's amount-bearing fields stay hidden. The plan needs complete economics: a positive recurring amount, an interval of at least 1, and at least two total payments; initialChargeAmount optionally overrides payment one (for example a bundled setup fee). The page must accept card only.

```json
{
  "name": "Gold Plan Enrollment",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Join the Gold Plan",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": "Enroll",
  "productName": "Gold Plan",
  "productDescription": "$49.99 today, then $29.99 per month for 11 more payments.",
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": "Standard",
  "allowLevel3LineItems": null,
  "pagePurpose": "SaveCardWithInitialCharge",
  "recurringPlan": {
    "recurringAmount": 29.99,
    "frequency": "Monthly",
    "interval": 1,
    "numberOfPayments": 12,
    "initialChargeAmount": 49.99
  },
  "captureMode": null
}
```

**Content type:** `application/*+json`

Schema: `PhoeniXGateHostedPaymentPageHostedPaymentPageCreateDto`

_Example: Classic Mode (full configuration)_

The original full-control hosted payment page builder with accordion-style configuration sections. Use this when you need fine-grained control over which fields are shown, theme/branding, donations, custom text, and disclosures.

```json
{
  "name": "Acme Online Checkout",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Pay Acme Corp",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": true,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "https://acme.example.com/checkout/submit",
      "enabled": true,
      "label": "Pay Now"
    },
    "edit": {
      "url": "https://acme.example.com/cart",
      "enabled": true,
      "label": "Edit Cart"
    },
    "continue": {
      "url": "https://acme.example.com/thank-you",
      "enabled": true,
      "label": "Continue"
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": "#ffffff",
    "panelBorderColor": "#e0e0e0",
    "buttonColor": "#0066cc",
    "buttonBorderColor": "#0066cc",
    "inputFieldBorderColor": "#cccccc",
    "inputFieldBackgroundColor": "#ffffff",
    "inputFieldFontSize": null,
    "inputFieldFontColor": "#333333",
    "inputFieldBackgroundFocusColor": "#f0f8ff",
    "backColor": "#fafafa",
    "fontColor": "#333333",
    "font": "Inter, sans-serif",
    "fontSize": null,
    "headerFont": "Inter, sans-serif",
    "headerFontColor": "#111111",
    "headerFontSize": null,
    "headerBackColor": "#ffffff",
    "headerBorderColor": "#e0e0e0",
    "customCSS": ""
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Required",
    "fieldTax": "Required",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Required",
    "fieldTotal": true,
    "fieldBillingAddr": "Required",
    "fieldShipAddr": "Required",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Summary",
    "customizeOrderPanelText": true,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": "Optional",
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": "https://acme.example.com/webhooks/hpp",
    "enableWebhookNotification": true,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": true,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": "By clicking Place Order you agree to Acme's Terms of Service.",
    "showDisclosures": true,
    "requireDisclosureAccept": true,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": "https://acme.example.com/terms",
    "aboutUsLink": null,
    "processButtonText": "Place Order",
    "headerText": "Secure Checkout",
    "promoText": null,
    "promoLink": null,
    "supportLink": "https://acme.example.com/support",
    "poweredByText": "Powered by Acme",
    "copyrightText": "© 2026 Acme Corp",
    "shippingInfoLink": null,
    "privacyPolicyLink": "https://acme.example.com/privacy"
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Classic",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": null,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": null,
  "productName": null,
  "productDescription": null,
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": null,
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": null,
  "allowLevel3LineItems": null,
  "pagePurpose": null,
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Streamlined Mode (Stripe-style)_

Simplified Stripe-inspired checkout with a clean two-column layout, fixed product, and minimum chrome. Designed to be embedded in an iframe on the merchant's site - configure AllowedEmbeddingDomains.

```json
{
  "name": "Annual Membership Checkout",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Annual Membership",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Hidden",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": false,
  "allowPromoCodes": true,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": true,
  "termsUrl": "https://acme.example.com/terms",
  "callToActionText": "Subscribe",
  "productName": "Annual Membership",
  "productDescription": "12 months of full access to all member benefits.",
  "productImageBlobName": null,
  "fixedAmount": 99,
  "allowCustomAmount": false,
  "successRedirectUrl": "https://acme.example.com/welcome",
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": [
    "acme.example.com",
    "*.acme.example.com"
  ],
  "checkoutLayout": "Standard",
  "allowLevel3LineItems": null,
  "pagePurpose": null,
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Save Card page (store a card, no charge)_

A dedicated card-capture page: the customer's card is validated with a zero-dollar account verification (authorize $0 with AVS/CVV, immediate void), vaulted as a reusable payment token, and stored-credential consent is captured. No charge is taken, so amount-bearing configuration (tax, tip, shipping, convenience fee, invoice amounts, donations) must stay hidden/off. Requires the merchant's processor to support zero-dollar verification.

```json
{
  "name": "Add Payment Method",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Save Your Card",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": "Save Card",
  "productName": "Card on File",
  "productDescription": "Securely save a card for future purchases. You will not be charged today.",
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": "Compact",
  "allowLevel3LineItems": null,
  "pagePurpose": "SaveCard",
  "recurringPlan": null,
  "captureMode": null
}
```

_Example: Save Card with Initial Charge (subscription enrollment)_

A card-capture page that also charges the first payment of an inlined recurring plan as a real sale, vaults the card with Recurring stored-credential consent, and creates a contract for the remaining payments. The charged amount comes entirely from the recurring plan, so the page's amount-bearing fields stay hidden. The plan needs complete economics: a positive recurring amount, an interval of at least 1, and at least two total payments; initialChargeAmount optionally overrides payment one (for example a bundled setup fee). The page must accept card only.

```json
{
  "name": "Gold Plan Enrollment",
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "isActive": true,
  "title": "Join the Gold Plan",
  "bannerImage": null,
  "hideBanner": false,
  "supportRetail": false,
  "usePostOnSubmit": false,
  "useCaptcha": false,
  "supportTokenization": true,
  "pageActions": {
    "submit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "edit": {
      "url": "",
      "enabled": false,
      "label": ""
    },
    "continue": {
      "url": "",
      "enabled": false,
      "label": ""
    }
  },
  "donations": {
    "enableDonationAmounts": false,
    "donationAmounts": [ ]
  },
  "theme": {
    "panelBackColor": null,
    "panelBorderColor": null,
    "buttonColor": null,
    "buttonBorderColor": null,
    "inputFieldBorderColor": null,
    "inputFieldBackgroundColor": null,
    "inputFieldFontSize": null,
    "inputFieldFontColor": null,
    "inputFieldBackgroundFocusColor": null,
    "backColor": null,
    "fontColor": null,
    "font": null,
    "fontSize": null,
    "headerFont": null,
    "headerFontColor": null,
    "headerFontSize": null,
    "headerBackColor": null,
    "headerBorderColor": null,
    "customCSS": null
  },
  "fieldsAndPanels": {
    "fieldInvoice": "Hidden",
    "fieldTax": "Hidden",
    "fieldConvenienceFee": "Hidden",
    "fieldShipping": "Hidden",
    "fieldTotal": true,
    "fieldBillingAddr": "Hidden",
    "fieldShipAddr": "Hidden",
    "panelWidthOrder": null,
    "panelWidthCustom": null,
    "panelWidthAddress": null,
    "panelWidthCard": null,
    "amountSetByCustomer": false,
    "panelWidthResult": null,
    "customerSetsInvoiceNumber": false,
    "fieldCustomerEmail": "Required",
    "fieldCustomerNameOnCard": "Hidden",
    "hideHeaderMenu": false,
    "orderPanelCustomText": "Order Details",
    "customizeOrderPanelText": false,
    "customFieldPanelCustomText": "Custom Fields",
    "customizeCustomFieldPanelText": false,
    "addressPanelCustomText": "Address",
    "customizeAddressPanelText": false,
    "cardPanelCustomText": "Card Data",
    "customizeCardPanelText": false,
    "resultPanelCustomText": "Result",
    "customizeResultPanelText": false,
    "showOrderPanelText": false,
    "showCustomFieldsText": false,
    "showAddressPanelText": false,
    "showCardPanelText": false,
    "showResultPanelText": false,
    "hideAddressAndPhone": false,
    "fieldTip": null,
    "panelLayout": null
  },
  "receiptAndNotifications": {
    "callbackUrl": null,
    "enableWebhookNotification": false,
    "enableCustomerEmail": true,
    "customerEmailLogo": null,
    "customerEmailFooter": null,
    "customerEmailBody": null,
    "useHostedConfirm": false,
    "receiptAdditionalText": null,
    "customerEmailAsPdf": false,
    "emailPurchaseNotifications": false,
    "purchaseNotifyEmails": [ ]
  },
  "disclosures": {
    "disclosureText": null,
    "showDisclosures": false,
    "requireDisclosureAccept": false,
    "achWebAuthorizationText": null,
    "achRecurringWebAuthorizationText": null
  },
  "customText": {
    "termsAndConditionsLink": null,
    "aboutUsLink": null,
    "processButtonText": "Process",
    "headerText": null,
    "promoText": null,
    "promoLink": null,
    "supportLink": null,
    "poweredByText": null,
    "copyrightText": null,
    "shippingInfoLink": null,
    "privacyPolicyLink": null
  },
  "isTemplate": false,
  "templateName": null,
  "templateDescription": null,
  "shareTemplate": false,
  "pageMode": "Streamlined",
  "collectBusinessName": null,
  "collectPhone": null,
  "allowPromoCodes": null,
  "collectTaxId": null,
  "savePaymentDetails": true,
  "requireTermsAcceptance": null,
  "termsUrl": null,
  "callToActionText": "Enroll",
  "productName": "Gold Plan",
  "productDescription": "$49.99 today, then $29.99 per month for 11 more payments.",
  "productImageBlobName": null,
  "fixedAmount": null,
  "allowCustomAmount": null,
  "successRedirectUrl": null,
  "paymentMethods": [
    "card"
  ],
  "customFieldNames": null,
  "allowedEmbeddingDomains": null,
  "checkoutLayout": "Standard",
  "allowLevel3LineItems": null,
  "pagePurpose": "SaveCardWithInitialCharge",
  "recurringPlan": {
    "recurringAmount": 29.99,
    "frequency": "Monthly",
    "interval": 1,
    "numberOfPayments": 12,
    "initialChargeAmount": 49.99
  },
  "captureMode": null
}
```

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateHostedPaymentPageHostedPaymentPageDto`

**Content type:** `application/json`

Schema: `PhoeniXGateHostedPaymentPageHostedPaymentPageDto`

**Content type:** `text/json`

Schema: `PhoeniXGateHostedPaymentPageHostedPaymentPageDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

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