Welcome to Zuora Product Documentation

Explore our rich library of product information

Enable Pix Automático using Payment Forms

Learn how to activate and configure Pix Automático on a Zuora Payment Form for the EBANX gateway in Brazil.

Before you begin, verify that the following prerequisites are met:

  • Payment Forms are activated for your tenant. If Payment Forms are not activated, submit a request to Zuora Global Support.
  • An EBANX payment gateway instance is configured with the Merchant Country set to Brazil. For more information, see Set up and configure an EBANX payment gateway instance.
  • The Pix payment method type is activated for your tenant in Settings > Payments. If Pix is not available, submit a request to Zuora Global Support.
  • Brazilian real (BRL) is configured as an active currency in your tenant.
  • You have the Payment Settings administrative permission in Zuora.

Pix Automático is the mandate-based recurring payment method in Brazil, built on Pix. When you use a Zuora Payment Form, you collect the Pix Automático authorization from the customer one time, and then process recurring payments against the resulting payment method without further customer interaction.

A Payment Form is different from a Payment Page 2.0. A Payment Form is the reusable, themeable hosted form that you configure in the Payments settings and render with the Zuora Payment SDK, including through Payment Links. If you use Payment Pages 2.0 instead, see Configure Pix on Payment Pages 2.0.

Pix Automático works with Payment Forms as follows:

  • On the Payment Form, the customer selects Pix, enters the payer details (name, email address, and Identity Number—CPF or CNPJ), and approves the Pix Automático mandate.
  • Zuora enrolls the mandate with EBANX and stores a Pix payment method on the billing account of the customer. The EBANX enrollment reference is stored as the token for subsequent debits.
  • After enrollment, Zuora processes recurring payments against the stored Pix Automático payment method, based on the mandate terms (subscription name, frequency, and start date).
  • Pix Automático transactions are processed in Brazilian real (BRL). The Merchant Country of the EBANX gateway instance must be set to Brazil.
  1. Navigate to Settings > Payments and open the Payment Form configuration.
  2. Open an existing Payment Form, or create one and enter a name in the Title field.
  3. In the list of payment methods on the form, activate Pix.
  4. Set the availability of Pix to the Brazil region.

    Pix is a region-specific method and is offered only in Brazil.

  5. Configure the Pix payer fields that the form collects.

    The following fields are required for Pix:

    Table 1. Required Pix payer fields
    FieldDescription
    First NameThe first name of the payer.
    Last NameThe last name of the payer.
    EmailThe email address of the payer.
    Identity NumberThe Brazilian tax identification number of the payer (CPF for individuals or CNPJ for businesses).

    You can also activate optional billing address fields (street number, street name, city, state, postal code, and country) and the phone number field.

  6. Configure the customer authorization statement for Pix.

    The authorization statement is the text that the customer agrees to when authorizing the Pix Automático mandate on the form. Enter a statement that clearly explains that the customer authorizes recurring Pix debits.

  7. Select Save to save the Payment Form.