Welcome to Zuora Product Documentation

Explore our rich library of product information

UPI Intent for EBANX payment gateway integration

UPI Intent enables customers in India to pay by selecting a UPI app on the Payment Page and approving the payment in that app through the EBANX integration.

This article documents functionality that is under active development. Confirm the final field labels, on-screen text, and behavior against the released feature before publishing.

Zuora supports UPI (Unified Payments Interface) Intent payments through the EBANX payment gateway integration. With UPI Intent, your customers in India select a preferred UPI app, such as Google Pay, PhonePe, or Paytm, on the Payment Page. A deep link opens the selected app, where the customer approves the payment. Unlike UPI Collect, your customer does not enter a Virtual Payment Address (VPA). Unlike UPI QR, your customer does not scan a QR code. UPI Intent is supported on Payment Pages 2.0.

You can use UPI Intent on EBANX for one-time payments and for recurring payments through UPI Autopay mandate-based enrollment.

Note: Zuora is deprecating UPI Collect and no longer accepts new UPI Collect enrollments. Existing UPI Collect enrollments continue to work. If you currently use UPI Collect on EBANX, migrate to UPI Intent or UPI QR to continue onboarding new customers.

Supported currency

EBANX processes UPI Intent transactions in Indian Rupee (INR) only. When you authorize an amount on the Payment Page, set the currency to INR. Set the merchant country of the EBANX gateway to India.

Supported operations

The following table lists the operations that Zuora supports for the UPI Intent payment method on EBANX.

OperationSupported
Create payment method (UPI Intent)Yes
One-time paymentYes
Store payment method for recurring use (UPI Autopay)Yes
Recurring off-session payment using a stored UPI Autopay payment methodYes
RefundYes

The current EBANX UPI integration supports payment method creation, recurring UPI Autopay processing, and referenced refunds. It also stores mandate-related identifiers for recurring use.

UPI Intent payment process

UPI Intent is an interactive, on-session payment method. Your customer must be present to select a UPI app and approve the payment in that app.

The customer experience is as follows:

  1. On the Payment Page, your customer selects UPI as the payment method and chooses a supported UPI app. Your customer does not need to enter a Virtual Payment Address (VPA).

  2. Zuora requests the transaction from EBANX and opens the selected UPI app through an app-specific deep link.

  3. Your customer reviews the payment details in the UPI app and enters the UPI PIN to authorize the payment.

  4. The Payment Page waits for confirmation from EBANX while your customer keeps the window open.

  5. When EBANX confirms the payment, the Payment Page returns a success result and completes.

  6. If the payment session expires before your customer completes the payment, the Payment Page prompts your customer to try again.

The UPI Intent payment session is valid for a limited time. To control how long Zuora waits for your customer to complete the authorization, use the timer window client parameter when you render the Payment Page. In the current EBANX UPI implementation, field_upiTimerWindow supports a minimum of 5 minutes and a maximum of 36 minutes. Zuora relies on EBANX asynchronous notifications and status checks to determine the final payment status, even if the browser session timer expires.

Payment flows

UPI Intent on EBANX supports one-time payments and recurring payments through UPI Autopay. To select a flow, combine the doPayment and storePaymentMethod client parameters when you render the Payment Page.

One-time payment

Use this flow to collect a single payment without storing the payment method for future use.

  • Your customer selects a UPI app and approves the payment.

  • Zuora processes a one-time payment for the authorized amount.

  • Zuora does not store a payment method and does not create a UPI Autopay mandate.

For any future payment, your customer must be present and approve a new payment in the UPI app.

Recurring payments with UPI Autopay

Use this flow to enroll your customer in UPI Autopay so that Zuora can process future recurring payments off-session without requiring your customer to approve each payment in the UPI app.

  • Your customer selects a UPI app and approves a UPI Autopay mandate.

  • Zuora submits the enrollment to EBANX UPI Autopay and stores a tokenized UPI Intent payment method on the customer account.

  • The stored payment method is linked to the approved mandate.

  • After enrollment, Zuora processes recurring payments against the stored payment method without further customer interaction, subject to the mandate terms, such as frequency and minimum and maximum amounts.

You can enroll your customer in one of the following ways:

  • Enroll with an initial payment. Zuora charges your customer the authorized amount during enrollment and stores the payment method for future recurring payments.

  • Enroll without an initial payment. Zuora stores the payment method for future recurring payments without charging the full amount during enrollment. To validate the mandate, Zuora charges a small validation amount and then automatically refunds it. The EBANX UPI QR page uses the same validation behavior for mandate enrollment without an initial payment.

Note: When you store a UPI Intent payment method for recurring use, you must enable the UPI mandate. Otherwise, EBANX rejects the request.