Pix Automática payment method creation through Zuora API
Zuora provides a REST API flow to create a Pix Automática payment method from an existing EBANX enrollment for recurring payments in Brazil.
Use the Zuora REST API to create a Pix Automática payment method from an existing EBANX enrollment. Use this flow when you collect and authorize the Pix Automática mandate in your own checkout experience. In this scenario, you do not use a Zuora-hosted payment page or Payment Form.
The flow stores the EBANX enrollment code in Zuora as the payment method token. You can then use the payment method for recurring payments through payment runs and other supported recurring payment flows.
Pix is an asynchronous payment method therefore, you must set up webhooks to know the final status of the payment. For more detailed information, see Configure a webhook in your EBANX dashboard.
Prerequisites
Verify that the following conditions are met:
-
Contact Global support to enable Pix payment method for your tenant.
-
Customer has completed Pix Automática enrollment through your external checkout or EBANX integration.
-
EBANX has returned the enrollment code, which is the
merchant_enrollment_codevalue. -
Enrollment contains the required customer information, including CPF or CNPJ and at least one contact method (email address or phone number).
-
Brazilian real (BRL) is configured for the account and payment method.
-
OAuth access token for the Zuora REST API and the ID of the EBANX gateway instance are available.
For information about configuring EBANX and enabling Pix Automática, see Prepare for the Pix Automática integration for EBANX payment gateway integration.
Recurring payment usage
After Zuora creates the payment method, complete the following actions:
-
Set the payment method as the default for the account, if appropriate.
-
Use the payment method in payment runs or other supported recurring payment flows.
-
Follow the mandate terms returned by EBANX, including mandate frequency, start date, expiration date, and maximum amount.
-
Monitor payment status and reconciliation results as you do for other Pix Automática payment methods.
Because Pix payments must be sent 2–10 days before the invoice due date, set the payment term for the account or invoice to NET3 or NET4.
For more information about recurring Pix Automática processing, see Pix Automática for EBANX payment gateway integration.
Limitations
-
This flow imports an existing EBANX enrollment. It does not initiate enrollment or collect customer authorization.
-
This flow does not generate a QR code, copy-and-paste code, or redirect URL for customer enrollment.