TPV S2S Integration - UPI Collect Flow

With UPI payments, your customers can make payments using a Virtual Payment Address (VPA) without the need to enter the bank account details. In the UPI Collect flow, customers enter their registered VPA at checkout, open the UPI PSP app and complete the payment.

Handy Tips

As per the NPCI guidelines, following are the restrictions on the UPI Collect Flow:

MCC 6540: UPI Collect Flow is not available for this MCC. You can use
UPI Intent Flow
as an alternative.
MCC 4812: The maximum amount is limited to ₹5,000 per transaction for UPI Collect Flow. You can use
UPI Intent Flow
as an alternative.
MCC 4814: The maximum amount is limited to ₹5,000 per transaction for UPI Collect Flow. You can use
UPI Intent Flow
as an alternative.

Best Practices

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

You should validate the VPA before initiating the payment request. Know more about
VPA Validation
.
You should add a custom UPI Collect expiry based on the business requirement to provide enough time for the customer to complete the payment.
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 Dashboard.

UPI Collect Flow

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

The customer selects UPI as the payment method and enters their VPA on your app or website. Razorpay validates the VPA.
The customer saves the entered VPA details while completing the payment. Razorpay saves the valid VPA details as tokens.
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

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

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.

POST

/customers

Request Parameters

name

optional

string Customer's name. Alphanumeric value with period (.), apostrophe ('), forward slash (/), at (@) and parentheses are allowed. The name must be between 3-50 characters in length. For example, Gaurav Kumar.

contact

optional

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919876543210.

optional

string The customer's email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.

fail_existing

optional

string Possible values:

0: If a customer with the same details already exists, fetches details of the existing customer.
1 (default): If a customer with the same details already exists, throws an error.

gstin

optional

string Customer's GST number, if available. For example, 29XAbbA4369J1PA.

notes

optional

object This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Step 1.2: Create an Order

You need to create an order before initiating the payment.

POST

/orders

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.

amount

mandatory

integer The transaction amount expressed in paise (currency supported is INR). For example, for an actual amount of ₹1, the value of this field should be 100.

currency

mandatory

string The currency in which the transaction should be made. You can create orders in INR only.

receipt

optional

string Receipt number that corresponds to this order, set for your internal reference. Maximum length is 40 characters.

notes

optional

json object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

method

mandatory

string The payment method used to make the payment. If this parameter is not passed, investors will be able to make payments using both netbanking and UPI payment methods. Possible values:

netbanking: Investors can make payments only using netbanking.
card: Investors can make payments using debit card.
upi: Investors can make payments only using UPI.

bank_account

mandatory

object Details of the bank account that the investor has provided at the time of registration.

account_number

mandatory

string The bank account number from which the investor should make the payment. For example, 765432123456789 Payments will not be processed for an incorrect account number.

name

mandatory

string The name linked to the bank account. For example, Gaurav Kumar.

ifsc

mandatory

string The bank IFSC. For example, HDFC0000053.

Step 1.3: Validate the VPA

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

POST

/payments/validate/vpa

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

vpa

mandatory

string The virtual payment address (VPA) you want to validate. For example, gauravkumar@exampleupi.

Step 1.4: Initiate a Payment

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

POST

/payments/create/upi

Request Parameters

amount

mandatory

integer The amount associated with the payment in the smallest unit of the supported currency. For example, 2000 means ₹20.

currency

mandatory

string ISO code of the currency associated with the payment amount. Only INR is supported.

order_id

mandatory

string Unique identifier of the order, obtained in the response of the previous step.

notes

optional

json object Key-value pairs that can hold additional information about the payment. Refer to the

Notes

section of the API Reference Guide.

description

optional

string Descriptive text of the payment.

contact

mandatory

string Phone number of the customer.

mandatory

string Email address of the customer.

save

boolean Specifies if the VPA should be stored as tokens. Possible values:

1 - Saves the VPA details.
0(default) - Does not save the VPA details.

customer_id

mandatory

string Unique identifier of the customer, obtained from the response of

Step 1

callback_url

optional

string URL where Razorpay will submit the final payment status.

mandatory

string The client's browser IP address. For example, 117.217.74.98

referer

mandatory

string Value of referer header passed by the client's browser. For example,

https://example.com/

user_agent

mandatory

string Value of user_agent header passed by the client's browser.
For example, Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36

upi

Details of the expiry of the UPI link

flow

mandatory

string Specify the type of the UPI payment flow.
Possible values:

collect (default)
intent

vpa

mandatory

string VPA of the customer where the collect request will be sent.

expiry_time

mandatory

integer Period of time (in minutes) after which the link will expire. The default value is 5.

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:

Step 2.1: Create an Order

You need to create an order before initiating the payment.

POST

/orders

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

amount

mandatory

integer The transaction amount expressed in paise (currency supported is INR). For example, for an actual amount of ₹1, the value of this field should be 100.

currency

mandatory

string The currency in which the transaction should be made. You can create orders in INR only.

receipt

optional

string Receipt number that corresponds to this order, set for your internal reference. Maximum length is 40 characters.

notes

optional

method

mandatory

string The payment method used to make the payment. If this parameter is not passed, investors will be able to make payments using both netbanking and UPI payment methods. Possible values:

netbanking: Investors can make payments only using netbanking.
card: Investors can make payments using debit card.
upi: Investors can make payments only using UPI.

bank_account

mandatory

object Details of the bank account that the investor has provided at the time of registration.

account_number

mandatory

string The bank account number from which the investor should make the payment. For example, 765432123456789 Payments will not be processed for an incorrect account number.

name

mandatory

string The name linked to the bank account. For example, Gaurav Kumar.

ifsc

mandatory

string The bank IFSC. For example, HDFC0000053.

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.

GET

/customers/:customer_id/tokens

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.

POST

/payments/create/upi

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_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

amount

mandatory

integer The amount associated with the payment in the smallest unit of the supported currency. For example, 2000 means ₹20.

currency

mandatory

string ISO code of the currency associated with the payment amount. Only INR is supported.

order_id

mandatory

string Unique identifier of the order, obtained in the response of the previous step.

customer_id

mandatory

string Unique identifier of the customer.

token

mandatory

string Token of the saved VPA.

notes

optional

json object Key-value pairs that can hold additional information about the payment. Refer to the

Notes

section of the API Reference Guide.

description

optional

string Descriptive text of the payment.

contact

mandatory

string Phone number of the customer.

mandatory

string Email address of the customer.

customer_id

mandatory

string Unique identifier of the customer.

callback_url

optional

string URL where Razorpay will submit the final payment status.

mandatory

string The client's browser IP address. For example, 117.217.74.98

referer

mandatory

string Value of referer header passed by the client's browser. For example,

https://example.com/

user_agent

mandatory

string Value of user_agent header passed by the client's browser.
For example, Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36

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:

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
  .

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

generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);

  if (generated_signature == razorpay_signature) {
    payment is successful
  }

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

set up webhooks

, make test payments, replace the test key with the live key and integrate with other

APIs

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.

Watch Out

You should deliver the products or services to your customers only after the payment is captured. Razorpay automatically refunds all the uncaptured payments.
You can track the payment status using our
Fetch a Payment API
or webhooks.

Authorized payments can be automatically captured. You can auto-capture all payments

using global settings

on the Dashboard. Know more about

capture settings for payments

Watch Out!

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

Orders API

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.

Watch Out!

This is a mock payment page that uses your test API keys, test card and payment details.

Ensure you have entered only your
Test Mode API keys
in the Checkout code.
Due to using test keys, no real money is deducted. This is a simulated transaction.

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 Dashboard to enable such payment methods.

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

supported banks

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

supported UPI flows

Handy Tips

You can use Test Mode to test UPI payments, and Live Mode for UPI Intent and QR payments.

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

supported card networks