TPV S2S Integration - UPI Intent Flow

Best Practices

Following are a few of the best practices to be followed to accept online payments using UPI Intent Flow:

1. Do not change Intent URL
   Do not make changes to the intent URL shared by Razorpay as part of the API response. Making changes to the intent URL can lead to payment failure.
2. Host UPI apps
   It is recommended to host the UPI apps on your page/app instead of just hosting the Intent URI where the native Android drawer shows the apps. This improves conversion.
3. Rank UPI Apps by Success Rate
   Show the UPI PSP apps in the order of their success rate.
4. Mobile site
   If you have higher traffic via mobile site, make sure you provide the option of UPI intent payment to your users using

   our m-site integration

   . This will help you achieve better success rates.
5. Gpay SDK
   If your UPI transaction volumes are high, you can also explore integrating

   Gpay SDK

   . This provides a better user experience and about a 3-5% improvement in success rate.

Prerequisites

• Contact our

  Support Team

  to get this feature enabled for your account.
• Keep the API key (combination of Key_Id and Key_Secret) handy for integration.

• Generate API Keys from the Dashboard

  if you have not done already.
• Configure the

  payment capture settings

  on the Dashboard.

UPI Intent Flow

Following is the process for accepting payments using the UPI Intent Flow:

Customers need not enter VPA or phone number as these details are pre-filled and submitted along with the other payment details. While making the payment, customers select the UPI PSP app on your app. The UPI PSP app is launched automatically on their mobile devices, where the payment is completed.

1. The customer selects UPI as the payment method.
2. The customer chooses their preferred UPI PSP app from the list.
3. The UPI PSP app opens automatically and the customer completes the payment.

Integration Steps

1. Create an order

   .

2. Initiate Payment using the intent URL

   .

3. Store Fields in your Server

   .

4. Verify the Signature

   .

Step 1: Create an Order

Given below is the sample code when method is upi.

If the user selects the payment method within the Razorpay UI, there is no need to include the method field. Below is a sample code for reference.

Request Parameters

Step 2: Initiate a Payment

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
  -X POST https://api.razorpay.com/v1/payments/create/upi \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100,
    "currency": "INR",
    "order_id": "order_Ee0biRtLOqzRjP",
    "email": "gaurav.kumar@example.com",
    "contact": "9000090000",
    "method": "upi",
    "ip": "192.168.0.103",
    "referer": "http",
    "user_agent": "Mozilla/5.0",
    "description": "Test flow",
    "notes": {
      "purpose": "UPI test payment"
    },
    "upi": {
      "flow" : "intent"
    }
  }'

Request Parameters

Following are the request parameters for the API:

You will get the UPI Intent URI as part of the payment response.

To pass the payment data to the respective UPI app and to initiate the payment, use the following code:

Intent i = new Intent(Intent.ACTION_VIEW);
        i.setData(Uri.parse(url)); //uri from the create S2S payment response
        i.setPackage(packageName); //package name from the `upi://pay` intent response

activity.startActivityForResult(i,2561); //unique activity code to get the callback

Step 3: Store Fields in your Server

A successful payment returns the following fields to the Checkout form.

• You need to store these fields in your server.
• You can confirm the authenticity of these details by verifying the signature in the next step.

Step 4: Verify the Payment Signature

This is a mandatory step to confirm the authenticity of the details returned to the Checkout form for successful payments.

To verify the razorpay_signature returned to you by the Checkout form:

1. Create a signature in your server using the following attributes:

   • order_id: Retrieve the order_id from your server. Do not use the razorpay_order_id returned by Checkout.
   • razorpay_payment_id: Returned by Checkout.
   • key_secret: Available in your server. The key_secret that was generated from the

     Dashboard

     .

2. Use the SHA256 algorithm, the razorpay_payment_id and the order_id to construct a HMAC hex digest as shown below:

   HMAC Hex Digest

   copy

   generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);
   
     if (generated_signature == razorpay_signature) {
       payment is successful
     }

3. If the signature you generate on your server matches the razorpay_signature returned to you by the Checkout form, the payment received is from an authentic source.

Generate Signature on Your Server

Given below is the sample code for payment signature verification:

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");


String secret = "EnLs21M47BllR3X8PSFtjtbd";


JSONObject options = new JSONObject();
options.put("razorpay_order_id", "order_IEIaMR65cu6nz3");
options.put("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");
options.put("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f");


boolean status =  Utils.verifyPaymentSignature(options, secret);

Post Signature Verification

After you have completed the integration, you can

Payment Capture Settings

After payment is authorized, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.

Related Information

• Webhooks

  (Recommended)

• Error Codes

  (Recommended)

• How Payment Gateway Works

• Payment States

• Settlements

• Refunds