Best Practices

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

1. You should validate the VPA before initiating the payment request. Know more about

   VPA Validation

   .
2. You should add a custom UPI Collect expiry based on the business requirement to provide enough time for the customer to complete the payment.
3. You should use the

   Saved VPA

   feature provided by Razorpay to provide a better customer experience and have a better conversion.

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 Razorpay Dashboard.

UPI Collect Flow

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

1. The customer selects UPI as the payment method and enters their VPA on your app or website. Razorpay validates the VPA.
2. The customer saves the entered VPA details while completing the payment. Razorpay saves the valid VPA details as tokens.
3. The next time the customer wants to make a payment using VPA, the customer can select the saved VPA and complete the payment.

Integration Steps

1. Create a Payment and a VPA Token

2. Create Payments Using Tokens

1. Create a Payment and a VPA Token

Follow these steps to create and save valid VPA tokens in the payment flow:

1. Create a customer or fetch the customer for whom VPA should be saved.

   .

2. Create an order.

3. Validate the VPA entered by the customer.

4. Initiate a payment.

Step 1.1: Create a Customer

Skip this step if the customer is already created for your account.

Create a customer whose VPAs should be saved with details such as email and contact.

The following endpoint creates or add a customer with basic details such as name and contact details. You can use this API for various Razorpay Solution offerings.

Request Parameters

Step 1.2: Create an Order

You need to create an order before initiating the payment.

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.

Step 1.3: Validate the VPA

Collect the VPA details of the customer and validate it as follows:

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/payments/validate/vpa \
-H "Content-Type: application/json" \
-d '{
  "vpa": "gauravkumar@exampleupi"
}'

Request Parameters

Step 1.4: Initiate a Payment

Once validated, save the VPA provided by the customer. Create a payment with the valid vpa as follows:

Request Parameters

2. Create Payments Using Tokens

On a repeat transaction, customers can make payments using the VPA tokens, which were saved earlier. Follow these steps to create a payment using a saved token:

1. Create an Order.

2. Fetch all tokens of a customer.

3. Initiate a payment with the token selected by the customer.

4. Verify Payment Signature

Step 2.1: Create an Order

You need to create an order before initiating the payment.

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.2: Fetch VPA Tokens of a Customer

You can retrieve all the card and VPA tokens of a customer if they have been previously saved.

Step 2.3: Initiate a Payment Using VPA Token

To initiate a payment using a VPA token, pass the customer_id and token parameters instead of the vpa parameter.

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": 600,
  "currency": "INR",
  "order_id": "order_ExhN1Y0100Dkjw",
  "email": "gaurav.kumar@example.com",
  "contact": "9000090000",
  "method": "upi",
  "customer_id": "cust_EIW4T2etiweBmG",
  "token": "token_EeO65VIv8BXZg5"
  "ip": "192.168.0.103",
  "referer": "http",
  "user_agent": "Mozilla/5.0",
  "description": "Test flow",
  "notes": {
    "note_key": "value1"
  }
}'

Request Parameters

Step 2.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
     Razorpay 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.

How to Capture Payments

• Auto-capture payments (recommended)
  Authorized payments can be automatically captured. You can auto-capture all payments

  using global settings

  on the Razorpay Dashboard.
  Watch Out!

  Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the

  Orders API

  .

• Manually capture payments
  Each authorized payment can also be captured individually. You can manually capture payments using:

  • Payment Capture API

  • Dashboard

Know more about

After the integration is complete, a Pay button will appear on your webpage/app.

Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test is successful.

You can make test payments using one of the payment methods configured at the Checkout.

Supported Payment Methods

Following are all the payment modes that the customer can use to complete the payment on the Checkout. Some of them are available by default, while others require approval from us. Raise a request from the

Netbanking

You can select any of the listed banks. After choosing a bank, Razorpay will redirect to a mock page where you can make the payment success or a failure. Since this is Test Mode, we will not redirect you to the bank login portals.

Check the list of

UPI

You can enter one of the following UPI IDs:

• success@razorpay: To make the payment successful.
• failure@razorpay: To fail the payment.

Check the list of

Cards

You can use one of the following test cards to test transactions for your integration in Test Mode.

• Use any valid expiration date in the future in the MM/YY format.
• Use any random CVV to create a successful payment.

Check the list of

Related Information

• Webhooks

  (Recommended)

• Error Codes

  (Recommended)

• How Payment Gateway Works

• Payment States

• Settlements

• Refunds

• Accept UPI payments