This article describes how to configure Payment Pages 2.0 on the Zuora UI to accept the Credit Card Reference type payments.
This feature is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available.
The Credit Card Reference Payment Pages can only work with CyberSource Tokenization gateway. Before you proceed, you must configure the CyberSource Tokenization gateway in your Zuora environment.
Configure Credit Card Reference Payment Pages 2.0
Before any integration work can begin, the Payment Page form must be set up in Zuora.
To create a Payment Pages 2.0 form:
- In Zuora, navigate to Settings > Payments, and click Setup Hosted Pages.
- (Optional) Configure rate limiting for Payment Pages.
- In the Type field, click and select Credit Card Reference. See Payment Methods to learn more about the payment type.
If your tenant has both Payment Pages 1.0 and Payment Pages 2.0 enabled, you see the Hosted Page 1.0 and Hosted Page 2.0 categories.
- Click create new hosted page.
- In the Basic Information area, enter the following information:
- Page Name: Type a name for your Payment Page form. This name is used to identify your form in Zuora. It is different from the title displayed on the form. You specify the form title in the Page Title field in the Page Configuration section.
- Hosted Domain: Type the domain address from which your Payment Page will be served. This is also the domain where your callback page resides. The value should be in the format: https://www.domain.com. Zuora validates this field for you. You will see an error message displayed on HPM iframe if the validation fails.
To allow your hosted payment pages and callback pages to reside in the subdomain of the hosted domain, enable the Allow Subdomain Callback for Hosted Pages setting. See Configure Payment Pages 2.0 for details.
Note that the Overlay Hosted Page mode does not support the Hosted Domain validation.
- Callback Path: Type the path on which the callback page file resides. Zuora appends this to the Hosted Domain entry to create the full URL to which the callback is sent. Specify a value in the format:
/app/callback_file.jsp. You are not required to include a file extension, for example,
.php. However, the callback path must begin with a forward slash character (
The Callback Path is only required if you are using the advanced implementation option, using the inline style form with an external submit button. The Callback Path setting is ignored when you implement the basic setup, i.e., using the overlay form or the inline form with the submit button inside.
- In the Security Information area, configure the following information:
- Limit the number of submission before CAPTCHA Challenge: Enter a threshold for the number of Payment Page submissions before the CAPTCHA challenge page is displayed on HPM iframe.
- Limit the number of submission before blocking Submission: Enter a threshold for the number of Payment Page submissions before Zuora blocks all subsequent requests.
For more information, see Configure Advanced Security Checks for Payment Pages 2.0.
- In the Payment Gateway area, select and click a CyberSource Tokenization gateway to use.
- In the Page Configuration area, enter the following information.
- Page Title: Type a title for the Payment Page form. Select Display to display the Page Tile on this Payment Page form.
- Page Description: Type a description for the form. Select Display to display the Page Description on this Payment Page form.
- For each field in the Page Fields section:
- Label Name: Enter the display label to be shown on this Payment Page.
- Display: Select the checkbox to display the field on the Payment Page.
- Required: Select the checkbox to make the field a required field.
- If you want to change the default display order of the input fields within a section, enter the number representing the display order of the field within the section.
- Submit Button: Type the label to display on the submit button. This label is applied only if the button is on the Payment Page form. See Client Parameters for Payment Pages 2.0 for the submitEnabled parameter, which controls the placement of the submit button.
- Client-Side Validation: Select Enable client-side validation to check the required fields for values.
- If the client-side validation is enabled, you can specify a custom error message for missing required fields in the Error Message field.
- Use the #fieldName variable in the error message to include the missing field name. For example, "Please enter a valid #fieldName to continue."
- CSS: Enter the custom CSS code for your page. You can review the CSS id and class names by using View Source or Inspect Element in Firefox or Chrome on the preview page of this Payment Pages form.
Ensure that you enter the valid CSS codes in this field. An error will occur if you include HTML tags or other invalid characters.
- Credit Card Type Detection: Select Enable automatic credit card type detection to identify the credit card type based on user's credit card number entry. Supported credit card types are AMEX, Visa, Discover, and MasterCard. See Automatic Detection of Credit Card Type for detail.
- Click generate and save page.
The Preview Payment Pages 2.0 page shows the page as it will be displayed on your website.