Skip to main content

Configure PIX type Payment Pages 2.0


Configure PIX type Payment Pages 2.0

This article describes how to configure Payment Pages 2.0 to enable your customers to create payment methods of the PIX type. For details about compatibility with the browsers, see Browser Support Policy.


  • An Ebanx gateway instance has been created on your Zuora tenant. PIX payment methods are supported only on Ebanx gateway integrations.
  • PIX payment method type is enabled on your tenant. For more information about enabling payment methods in Zuora, see Define and set up payment methods.

Create a PIX type of Payment Page

  1. Navigate to Settings > Payments, and click Setup Payment Page and Payment Link.
  2. On the Payment Pages tab page, configure the tenant-level settings for the hosted payment page.
  3. In the Type dropdown list, select Pix.
  4. Click Create New Hosted Page.
  5. 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: 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, .jsp or .php. However, the callback path must begin with a forward slash character ( / ).

      The Callback Path is only required when 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.

  6. In the Security Information area, configure the page-level security settings. For detailed information about each option, see Security Measures for Payment Pages 2.0.
  7. In the Payment Gateway area, click and select an Ebanx instance in the Default Payment Gateway field. Note that Zuora does not validate this setting. You can override this default gateway in your request by specifying a gateway through the paymentGateway client parameter.
  8. In the Page Configuration area, complete the field configuration. Except for the following fields, you do not need to configure any form fields because the card issuer drop-down list is the only field on your hosted payment page and the list will be automatically loaded when your payment page is rendered.
    • Page Title: Enter a title for the Payment Page form. Select Display to display the Page Title on this Payment Page form.
    • Page Description: Enter the description of the form. Select Display to display the Page Description on this Payment Page form.
    • For each field in the Page Fields section, complete the following configuration. For more information about the fields, see Payment Pages 2.0 form fields.
      • Label Name: Enter the display label to be displayed on this payment page.
      • Display: Select this option to display the field on the payment page.
      • Required: Make sure the First Name, Last Name, email, and Identity Number fields are selected.
      • If you want to change the default display order of the input fields, enter the number representing the display order of the field.
    • 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 information about the submitEnabled parameter that 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.
      • In the Error Message field, use "#fieldName" to include the missing field name in the error message. 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. For example, you can customize the style and format of the field label and error message, as well as the error message texts. However, implementing customized JavaScript is not allowed for security reasons.

      Design Payment Pages CSS provides a CSS pack that you can download and use to design the look and formatting of your Payment Pages 2.0 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.

  9. Click Generate and Save Page.

Subsequently, you can preview Payment Pages 2.0 to preview the form that will be displayed on your website. 

What's next

Because PIX payment methods on Ebanx can only be created through the one-time payment flow of Payment Pages 2.0, you must implement a one-time payment flow after you create the PIX type of hosted payment page. For details, see Implement one-time payment flows on Ebanx.