UPI Component

Add UPI to an existing Components integration.

This page explains how to add UPI to your existing Web Components integration.

Requirements

Select the server-side flow that your integration uses:

Requirement	Description
Integration type	Make sure that you have built a Sessions flow Web Components integration. The minimum required version is 5.27.0.
Setup steps	Before you begin, add UPI in your Customer Area.

Import resources for v6

If you are using Web Components v6, import the Component that you need for UPI:


Copy code
import { AdyenCheckout, UPI } from '@adyen/adyen-web'

API reference

You do not need to send additional fields for UPI. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

/sessions: This is the default with Components v5.0.0 or later.
/payments: If you implemented an additional use case.

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:


Copy code
 <div id="upi-container"></div>

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

Your instance of AdyenCheckout.


Copy code
const upi = new UPI(checkout).mount('#upi-container');

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:


Copy code
const upiComponent = checkout.create('upi').mount('#upi-container');

Optional configuration

Property	Description
`defaultMode` v5.25.0 or later	Configures which payment option is selected by default. Possible values: - vpa: UPI Collect. - qrCode: UPI QR. - intent: UPI Intent ( v5.66.0 or later ).

Test and go live

Depending on your account setup, you may have access to the UPI simulator which you can use to test your UPI integration. Contact your Account Manager or our Support Team if you have questions about the simulator.

You can also use your personal account on a UPI app to test your integration by making live payments with a low value.