Implement UPI on Adyen Integration v2.0

Overview

Unified Payments Interface (UPI) is an Indian instant payment system developed by the National Payments Corporation of India (NPCI). It enables users to link multiple bank accounts to a single mobile application, facilitating inter-bank transactions through a user-friendly process.

Zuora's Adyen Integration v2.0 supports UPI transactions in INR. To support UPI one-time and recurring payment flows, you can implement a hosted payment page through Payment Pages 2.0.

Step 1. Prepare for the integration

Before implementing the UPI payment method on Adyen, ensure that all prerequisites outlined in the following sections are fulfilled.

Step 2. Create and configure a UPI payment page 

Complete the following steps to create and configure a UPI payment page:

1. In Zuora UI, 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 UPI.
4. Click Create New Hosted Page.
5. In the Basic Information section, specify the following fields:

   Field	Description
   Page Name	Enter a name for your hosted payment page. This name is used to identify your payment page in Zuora. It is different from the title displayed on the payment page. You can specify the title in the Page Title field in the Page Configuration section.
   Hosted Domain	Enter the domain address from which your payment page is served. This domain also hosts your callback page. The value must be in the format: https://www.domain.com. Zuora validates this field for you. If the validation fails, an error message is displayed on the payment page. Note that the Overlay Hosted Page mode does not support the hosted domain validation. If you want your hosted payment pages and callback pages to reside in the subdomain of the hosted domain, enable the tenant-level Allow Subdomain Callback for Hosted Pages setting.
   Callback Path	Enter 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. The file extension, such as .jsp or .php, is not required. However, the callback path must begin with a forward slash character ( / ). The Callback Path is only required for the advanced implementation option, which uses the inline style form with an external submit button. This setting is ignored for the basic setup, which uses the overlay form or the inline form with the submit button inside.

6. In the Default Payment Gateway field of the Payment Gateway section, click and select an Adyen Integration v2.0 instance. 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.
7. In the Page Configuration section, complete the field configuration.

   Field	Description
   Page Title	Enter a title for the hosted payment page. Select Display to display the Page Title on this payment page.
   Page Description	Enter the description of the payment page. Select Display to display the Page Description on this payment page.
   VPA	A required field for end-customers to enter a Virtual Payment Address to securely complete payments.
   Submit Button	Enter the label to appear on the submit button. This label is applied only if the button is on the hosted payment page. The submitEnabled client parameter controls the placement of the submit button. See Client Parameters for Payment Pages 2.0 for details.
   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 "#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 page. For example, you can customize the style and format of the field label and the error message, as well as the error message texts. However, implementing customized JavaScript is not allowed for security reasons. Note that the UPI timer window designed by Zuora cannot be altered.

8. Click Generate and Save Page.

Subsequently, you can preview the form. 

Step 3. Request a signature for the Payment Page

Follow the instructions in Request a signature for the Payment Page from Zuora. Because the Client-side HPM Parameter Validation feature is enabled, Zuora will validate the additional fields in the request by comparing them with the values specified in the digital signature.

Here are two request examples for the Generate RSA signature REST API operation.

{
    "uri":"https://sandbox.na.zuora.com/apps/Pu...tedPageLite.do",
    "method":"POST",
    "pageId":"test808145b3bf9d0145b3c6812b0008",
    "paymentGateway":"Adyen",
    "authroizationAmount":"100",
    "currency":"INR",
    "accountId":"test808145b3bf9d0145b3c6812b0008"
}

{
    "uri":"https://sandbox.na.zuora.com/apps/Pu...tedPageLite.do",
    "method":"POST",
    "pageId":"test808145b3bf9d0145b3c6812b0008",
    "paymentGateway":"Adyen",
    "accountId":"test808145b3bf9d0145b3c6812b0008"
}

Step 4. Set up your client code

Follow the instructions in Integrate Payment Pages 2.0. When rendering the Payment Page form, specify the following required parameters in the Z.render or Z.renderWithErrorHandler function. For other optional parameters, see Client Parameters for Payment Pages 2.0.

var params = {
    field_upiTimerWindow:20,
    doPayment:"true",
    storePaymentMethod:"true",
    field_accountId:"testc0f87596f2f301759c29443622fa",
    documents:"[{"type":"invoice","ref":"INV00026338"}, {"type":"invoice","ref":"INV00026339"}]",
    param_gwOptions_UpiMandateEnabled:"true",
    param_gwOptions_UpiMandateAmount:100000,
    param_gwOptions_UpiMandateAmountRule:"max",
    param_gwOptions_UpiMandateFrequency:"adhoc",
    param_gwOptions_UpiMandateStartsAt:"2024-05-06",
    param_gwOptions_UpiMandateEndsAt:"2024-09-28",
    param_gwOptions_UpiMandateRemarks:"sample message",
    param_gwOptions_UpiMandateBillingAttemptsRule:"after",
    param_gwOptions_UpiMandateBillingDay:"1"
};

Step 5. Implement the callback response

See Advanced Integration of Payment Pages 2.0 for more information.

Related information

• Overview of Adyen Integration v2.0
• Set up and configure an Adyen Integration v2.0 instance