Integrate Turbo UPI TPV

Third-party validation (TPV) of bank accounts is mandatory for businesses in the BFSI (Banking, Financial Services and Insurance) sector dealing with Securities, Broking and Mutual Funds. You can accept customer payments by integrating with the Turbo UPI Headless - TPV SDK.

Prerequisites

Contact our
integrations team
to get your mobile number, app and GitHub account whitelisted to get access to the https://github.com/upi-turbo/android-turbo-sample-app - sample app repository. In this repository, you will find the AAR files (libraries for Turbo UPI) and the sample app source code to help you do the entire integration. The AARs on the main branch are for the UAT environment, and the ones on the prod branch are for the production environment.
These are the important files in the sample app repo:
- app/src/turboUI: Sample app code for UI SDK
- app/libs: All libraries (Bank, SecureComponent and Turbo) common for headless and UI SDK
- app/build.gradle: All transitive dependencies needed to integrate the Turbo SDK.
Integrate with
Razorpay Android Custom SDK
.
Import the following frameworks:
- Razorpay Turbo Wrapper Plugin SDK (maven)
- Razorpay Turbo Core SDK
- Razorpay SecureComponent SDK
- Bank SDK
Add the following lines to your Android project's gradle.properties file:
- android.enableJetifier=true
- android.useAndroidX=true

Watch Out!

minSDKversion for using Turbo UPI is currently 19 and cannot be over written.
Use the rzp_test_5sHeuuremkiApj API key id for testing on the UAT environment and the
Razorpay live keys
for prod testing.
As a compliance requirement, you need to get approval from Google for READ_SMS permission. Refer
to the Google article
for more details.
If the user changes their mobile number during onboarding, you should store the updated number and pass it to the Turbo SDK.

1. Integration Steps

Given below are the steps:

Step 1: Whitelist Customer Bank Accounts (Optional)

You can whitelist (also known as allowlist) your customer's bank accounts to ensure that only those accounts are considered during customer onboarding. By whitelisting the accounts at the start, you can avoid the bank account linking during payment. Use the Customer APIs to create customers and add their bank account details.

For example, if a customer, Gaurav, has two bank accounts ABC and XYZ, you can use the APIs to create a customer id and link the bank accounts to that id. You can then pass this customer id at the time of payment.

Follow these steps.

Step 1.1: Create a Customer

Use this endpoint to create or add a customer with basic details such as name and contact details.

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/customers \
-H "Content-Type: application/json" \
-d '{
    "name": "Gaurav Kumar",
    "contact": "9123456780",
    "email": "gaurav.kumar@example.com",
    "fail_existing": "0",
    "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
    }
}'

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”.

Response Parameters

string Unique identifier of the customer. For example, cust_1Aa00000000004.

name

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

contact

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

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

gstin

string GST number linked to the customer. For example, 29XAbbA4369J1PA.

notes

json 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”.

created_at

integer UNIX timestamp, when the customer was created. For example, 1234567890.

Step 1.2: Add Customer's Bank Account

The following endpoint adds the customer's bank accounts.

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/customers/:customer_id/bank_account \
-H "Content-Type: application/json" \
-d '{
       "ifsc_code": "UTIB0000194",
       "account_number": "11214311215411",
       "beneficiary_name": "Gaurav",
       "beneficiary_address1": "address 1",
       "beneficiary_address2": "address 2",
       "beneficiary_address3": "address 3",
       "beneficiary_address4": "address 4",
       "beneficiary_email": "gaurav.kumar@example.com",
       "beneficiary_mobile": "9900990099",
       "beneficiary_city": "Bangalore",
       "beneficiary_state": "KA",
       "beneficiary_country": "IN"
   }'

Path Parameter

customer_id

mandatory

string Customer id of the customer whose bank account is to be added.

Request Parameters

account_number

mandatory

string Customer's bank account number. For example, 11214311215411.

beneficiary_name

mandatory

string The name of the beneficiary associated with the bank account.

beneficiary_address1

optional

string The virtual payment address.

beneficiary_email

optional

string Email address of the beneficiary. For example, gaurav.kumar@example.com.

beneficiary_mobile

optional

string Mobile number of the beneficiary.

beneficiary_city

optional

string The city of the beneficiary.

beneficiary_state

optional

string The state of the beneficiary.

beneficiary_country

optional

string The country of the beneficiary.

beneficiary_pin

optional

integer The pin code of the beneficiary's address.

ifsc_code

mandatory

string The IFSC of the bank branch associated with the account.

Response Parameters

bank_accounts

array An array containing bank account details.

string Unique identifier of the bank account.

entity

string The type of entity, which in this case is bank_account.

ifsc

string The IFSC of the bank branch associated with the account.

bank_name

string The name of the bank.

name

string The name associated with the bank account.

notes

object Set of key-value pairs that can be used to store additional information about the payment.

account_number

integer Customer's bank account number. For example, 11214311215411.

Step 2: Create an Order (Mandatory)

Pass the investor bank account details to the bank_account array of the Orders API. Given below is the sample code when the method is upi.

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
   "amount": 500,
   "method": "upi",
   "receipt": "BILL13375649",
   "currency": "INR",
   "bank_account": {
       "account_number": "765432123456789",
       "name": "Gaurav Kumar",
       "ifsc": "HDFC0000053"
   }
}'

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

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.

Response Parameters

string Unique identifier of the order.

entity

string Indicates the type of entity. Here, it is order.

amount

integer The order amount represented in the smallest unit of the currency passed. For example, amount = 100 translates to 100 paise, that is ₹1 (default currency is INR).

amount_paid

integer The amount that has been paid.

amount_due

integer The amount that is yet to be paid.

currency

string The 3-letter ISO currency code for the payment. Currently, we support INR only.

receipt

string A unique identifier of the order entered by the user. For example, BILL13375649.

status

string The status of the order.

notes

object Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.

created_at

integer The Unix timestamp at which the order was created.

offer_id

string Unique identifier of the offer.

attempts

integer The number of payment attempts, successful and failed, that have been made against this order.

Step 3: Turbo UPI Headless SDK Action

You need to link the customer's UPI account with your app. Use the code samples given below to

fetch the UPI account

3.1 Get Customer's Linked UPI Account

Use the following code to fetch your customer's UPI account. If there are no linked UPI accounts, an empty list is returned.

razorpay.upiTurbo.getLinkedUpiAccounts("<customerMobile>", new UpiTurboResultListener(){
   @Override
   public void onError(@NonNull Error error) {
       //Display error message to user. 
   }

   @Override
   public void onSuccess(@NonNull List<UpiAccount> accList) {
   if (accList.size()==0){
       //Display: no UpiAccounts onboarded yet. Please onboard an account.
   }else{
       //Display onboarded UpiAccounts. 
   }
   }
});

Watch Out!

If the device binding is not completed and the getLinkedUpiAccounts is triggered, it will return OnError with a DEVICE_BINDING_INCOMPLETE error message.

Request Parameters

Response Parameters

Handy Tips

Filter bank accounts related to each orderID or Whitelisted accounts.
You need to select which bank accounts users can use for payments.
For new users, you should display them the approved bank accounts that they can use for transactions. Users need to choose one from the provided list.

3.2 Link new UPI Account

Use the following code to link the newly created UPI account with your app. This function can be called from anywhere in the application, providing multiple entry points for customers to link their UPI account with your app.

Handy Tips

If the order is not created, you can provide CustomerId to get bank accounts whitelisted for the customer.

razorpay.upiTurbo
.getTPV()
.setCustomerMobile(919900990099)
.setCustomerId(cust_DAtUWmvpktokrT)
.setOrderId(order_L2MUBUOeFItcpU)
.setTpvBankAccount(
    TPVBankAccount(
    accountNumber = tpvAccountNumber,
    ifsc = tpvAccountIfsc,
    bankName = tpvAccountName
    )
)
.linkNewUpiAccount(new UpiTurboLinkAccountListener() {
   @Override
   public void onResponse(@NonNull UpiTurboLinkAction action) {
       switch (action.getCode()) {
           case ASK_FOR_PERMISSION:
               action.requestPermission();
               break;
           case SHOW_PERMISSION_ERROR:
               // Show dialog to redirect the user to the settings page of the application to grant permissions
               break;
           case SELECT_SIM:
               if (action.getError() != null) {
                   // Display error message
               return;
           }
               if (action.getData() != null && action.getData() instanceof List) {
                   try {
                       List<?> simList = (List<?>) action.getData();
                       Sim sim1 = (Sim) simList.get(0);
                       Sim sim2 = (Sim) simList.get(1);
                       // Show dialogue with a list of sims
                       action.selectedSim(sim1);
               } catch (ClassCastException e) {
               }
           }
           break;
           case SETUP_UPI_PIN:
               Card card = new Card("01", "28", "234567");
               action.setupUpiPin(card);
           break;
           case STATUS:
               if (action.getError() != null) {
               // Show error message
               return;
               }
               if (action.getData() != null && action.getData() instanceof List) {
               List<?> onboardedUpiAccounts = (List<?>) action.getData();
               showUpiAccount((TPVEnabledAccount) onboardedUpiAccounts.get(0));
           }
           break;
           case LOADER_DATA:
               // Use this trigger to easily show background processes happening in the SDK during onboarding
               showLoaderData((String) action.getData());
           break;
           }
       }
});

Request Parameters

action

The current state of customer registration with which you can call further functions. All values for this variable are exposed as an enum for ease of integration. Know more about the

action parameters

mobileNumber

mandatory

Mobile number of the customer.

customer_id

The unique identifier of the customer. You can create customer_id using the

Customers API

tpvBankAccount

conditionally mandatory

The tpvBankAccount parameter represents a bank account configuration used for UPI transactions, containing the account number, IFSC, and bank name.

order_id

conditionally mandatory

Order ID generated via

Orders API

Parameter Combinations and Descriptions

Conditions for `SELECT_SIM` action

Conditions for SELECT_SIM action:

Triggered:
- CASE 1: The customer's phone has only one SIM, but the mobile number provided is not the same as the mobile number in the SIM object.
- CASE 2: The customer's phone has multiple SIMs, but the mobile number provided is not the same as the mobile number in the SIM object in either SIMs.
Non-Triggered:
- CASE 1: The customer's phone has one SIM, and the mobile number provided is the same as the mobile number in the SIM object received.
- CASE 2: The customer's phone has multiple SIMs, and the mobile number provided is the same as the mobile number in one of the SIM objects received by the OS.

To understand error codes for linkNewUpiAccount, refer to the

Error Codes of linkNewUpiAccount section

3.3 Submit Method

To accept payments, call Custom Checkout’s submit method with the following payload:

JSONObject payload = new JSONObject();
payload.put("currency", "INR");
payload.put("email", "gaurav.kumar@example.com");
payload.put("contact", "919000090000");
payload.put("amount", "10000");
payload.put("method", "upi");
JSONObject upiBlock = new JSONObject();
upiBlock.put("flow", "in_app");
payload.put("upi", upiBlock);
payload.put("order_id", "order_L2MUBUOeFItcpU");//mandatory
payload.put("customer_id", "cust_KQlMczYKcDIqmB");//optional

Pass the vpa and payload objects as shown in the code below:

HashMap<String, Object> turboPayload = new HashMap<>();
turboPayload.put("upiAccount", upiAccount);
turboPayload.put("payload", payload);
razorpay.submit(turboPayload, new PaymentResultWithDataListener() {
@Override
public void onPaymentSuccess(String razorpayPaymentID, PaymentData paymentData) {
    //show success message
}
@Override
public void onPaymentError(int code, String response, PaymentData paymentData) {
    //Show error message
}
});

Handy Tips

In case of an error response, you will get a nested reason JSON object, which will contain the original error code and description from the bank/Secure component.

Steps 4: 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.

{
 "razorpay_payment_id": "pay_29QQoUBi66xm2f",
 "razorpay_order_id": "order_9A33XWu170gUtm",
 "razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}

Parameters

razorpay_payment_id

string Unique identifier for the payment returned by Checkout only for successful payments.

razorpay_order_id

string Unique identifier for the order returned by Checkout.

razorpay_signature

string Signature returned by the Checkout. This is used to verify the payment.

Step 5: Verify 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
  Razorpay 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.

Non-Transactional Flow

You can directly interact with the exposed methods of the Turbo Framework to perform the non-transactional flows listed below.

Fetch Balance

Fetch the customer's account balance. Call getBalance() on the bank account object received from upiAccount.

Change UPI PIN

Enable the customer to change their UPI PIN. Call changeUpiPin() on the bank account object received from UpiAccount.

Reset UPI

Let your customers reset the PIN for their account.

Delink

Let your customers delink, that is, remove a selected UPI account from your application.

Additional Features

The below function is triggered internally after integrating with the Razorpay Android Custom SDK.

@Override
public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults){
    razorpay.upiTurbo.onPermissionsRequestResult()
    super.onRequestPermissionsResult(requestCode, permissions, grantResults);
}

razorpay.onBackPressed() is triggered when a user tries to exit the app or return to the previous page. The razorpay.upiTurbo.destroy() function clears that particular session so that when the user returns, the payment process starts from the beginning.
@Override
public void onBackPressed() {
razorpay.onBackPressed();
razorpay.upiTurbo.destroy();
super.onBackPressed();
}
To get the device binding status, please use the variable razorpay.upiTurbo.isDeviceOnboarded() of type boolean. It indicates whether the device binding, which is a prerequisite for adding UPI accounts, is done with the customer's mobile number.
if(razorpay.upiTurbo.isDeviceOnboarded()){
// Device Binded
}else{
// Call linkNewUpiAccount for Device Binding
}

Handy Tips

You can use the following S2S APIs to maintain and fetch a list of all tpv bank accounts for a customer.

Use the
Add Bank Account of Customers API
to add bank account of the customers.
Use the
Delete Bank Account of Customers API
to delete bank account of the customers.

Action Parameter Values

Following are the constants passed in the action.code parameter in onResponse.

Error Codes for `linkNewUpiAccount`

Error Codes for Delete Bank Account API

Case 1: The bank account ID provided by users does not exist in Razorpay.

{
"error": {
   "code": "BAD_REQUEST_BANK_ACCOUNT_DOES_NOT_EXISTS",
   "description": "Bank Account does not exist",
   "source": "business",
   "step": "delete_bank_account",
   "reason": "bank_account_does_not_exist",
   "metadata": {},
   "field": "bank_account_id"
}
}

Case 2: The bank account ID provided by user is already deleted

{
"error": {
   "code": "BAD_REQUEST_ERROR",
   "description": "Bank Account is already deleted",
   "source": "business",
   "step": "bank_account_deletion",
   "reason": "bank_account_already_deleted",
   "metadata": {},
   "field": "bank_account_id"
}
}

Case 3: When one business attempts to delete the bank account of another business

{
"error": {
   "code": "BAD_REQUEST_ERROR",
   "description": "Bank Account does not exist",
   "source": "business",
   "step": "bank_account_deletion",
   "reason": "bank_account_does_not_exist",
   "metadata": {},
   "field": "bank_account_id"
}
}

Case 4: When a business provides an incorrect API key or API secret

{
"error": {
   "code": "BAD_REQUEST_ERROR",
   "description": "Unauthorized",
   "source": "business",
   "step": "bank_account_deletion",
   "reason": "unauthorized",
   "metadata": {},
   "field": "bank_account_id"
}
}

Models Exposed from the SDKs

The SDKs given below provide access to exposed models for seamless integration.

TPVBankAccount

BankAccount

Bank

AccountBalance

Error

Download list of possible error reasons

[This is the latest version of the list and was last updated on February 27th, 2024]

UpiAccount

SIM

Card

AllBanks

UpiTurbo.LinkAction

2. Test Integration

We recommend the following:

Complete the integration on UAT before using the prod builds.
Perform the UAT using the Razorpay-provided API keys.

3. Go-live Checklist

Complete these steps to take your integration live:

You should get your app id whitelisted by Razorpay to test on prod.

Handy Tips
Contact our
integrations team
to get your mobile number and app whitelisted.
Import the prod library from the Github repository → https://github.com/upi-turbo/android-turbo-sample-app/tree/prod/app/libs prod branch.
Add Proguard rules:
- keepclassmembers,allowobfuscation class * { @com.google.gson.annotations.SerializedName <fields>; }
- keepclassmembers enum * { *; }
- keepclassmembers class * { @android.webkit.JavascriptInterface <methods>; }
- dontwarn com.razorpay.**
- keep class com.razorpay.** {*;}
- keep class com.olivelib.** {*;}
- keep class com.olive.** {*;}
- keep class org.apache.xml.security.** {*;}
- keep interface org.apache.xml.security.** {*;}
- keep class org.npci.** {*;}
- keep interface org.npci.** {*;}
- keep class retrofit2.** { *; }
- keep class okhttp3.** { *; }
Replace the UAT credential with the
Razorpay live keys
for prod testing.

Integrate Turbo UPI TPV

Prerequisites

1. Integration Steps

Step 1: Whitelist Customer Bank Accounts (Optional)

Step 1.1: Create a Customer

Request Parameters

Response Parameters

Step 1.2: Add Customer's Bank Account

Path Parameter

Request Parameters

Response Parameters

Step 2: Create an Order (Mandatory)

Request Parameters

Response Parameters

Step 3: Turbo UPI Headless SDK Action

3.1 Get Customer's Linked UPI Account

Request Parameters

Response Parameters

3.2 Link new UPI Account

Request Parameters

Parameter Combinations and Descriptions

Conditions for SELECT_SIM action

3.3 Submit Method

Steps 4: Store Fields in your Server

Parameters

Step 5: Verify Signature

Non-Transactional Flow

Fetch Balance

Change UPI PIN

Reset UPI

Delink

Additional Features

Action Parameter Values

Error Codes for linkNewUpiAccount

Error Codes for Delete Bank Account API

Case 1: The bank account ID provided by users does not exist in Razorpay.

Case 2: The bank account ID provided by user is already deleted

Case 3: When one business attempts to delete the bank account of another business

Case 4: When a business provides an incorrect API key or API secret

Models Exposed from the SDKs

TPVBankAccount

BankAccount

Bank

AccountBalance

Error

UpiAccount

SIM

Card

AllBanks

UpiTurbo.LinkAction

2. Test Integration

3. Go-live Checklist

Conditions for `SELECT_SIM` action

Error Codes for `linkNewUpiAccount`