Integrate Turbo UPI (with UI) on Android App

Integrate Steps

1.1 Create a Session Token

To enhance security, you must create a session token via a server-to-server (S2S) call between your backend and Razorpay's backend. This session token ensures secure communication between the Turbo SDK and Razorpay's systems.

How to Create a Session Token

1. Trigger the S2S API from your Backend. Use the following API to generate a session token:

   Environment based URLs:

   • UAT: https://api-web-turbo-upi.ext.dev.razorpay.in

   • Production: https://api.razorpay.com

   Authorization Header Creation: Base64.encode(${public_key}:${secret})

   Request Parameters

   customer_reference

   mandatory

   string A unique identifier for the customer provided by the business. The recommended value is mobile number. For example, 9000090000.

   Response Parameters

   token

   string A session token to be used in subsequent session-protected APIs.

   expire_at

   long Expiry time (in seconds) for the session token, used to optimise session handling and reduce unnecessary reinitialisations.

   error

   object The request failure due to business or technical failure.

2. Pass the Generated Token to Turbo SDK. Use the session token in the

   initialisation step

   , ensuring that it is refreshed upon expiry.

1.2 Initialise Turbo SDK

Initialise the TurboSessionDelegate object anonymously and pass it through the initialize method. The SDK will call fetchToken function whenever required to get new token.

In the fetchToken function, retrieve a new token from your server section, check

TurboSessionDelegate turboSessionDelegate = completion -> {
            // Fetch token here and once fetched,
            // it can be passed back to Turbo SDK using the completion callback
            completion.invoke(new Session("<new-token>"));
        };

            // pass the above created turboSessionDelegate object through initialize method
razorpay
    .upiTurbo
    .initialize(turboSessionDelegate)

Create/Retry Session Token Mechanism

Initialise the TurboSessionDelegate object anonymously and pass it through the initialize method. The SDK will call fetchToken as needed and use the provided callback to handle the updated token. This allows you to seamlessly refresh the session by retrieving a new token via a server-to-server (S2S) call.

Below is an example of creating an instance of the TurboSessionDelegate interface using an anonymous object expression:

val turboSessionDelegate: TurboSessionDelegate = object : TurboSessionDelegate {
        override fun fetchToken(completion: (Session) -> Unit) {
        	// fetch token here and once fetched,
		// it can be passed back to Turbo SDK using completion lambda callback
 	completion(Session(token: <new-token>))
        }
}

// pass the above created turboSessionDelegate object through initialize method

1.3 Getting Linked UPI Accounts

After initialising the Turbo SDK, proceed to securely link UPI accounts and complete the payment flow.

1. Get already linked accounts.

   If your customer has already linked accounts, use the following code to fetch them. If there are no linked UPI accounts, an empty list is returned.

   Handy Tips

   When the user arrives at your checkout screen, use the getLinkedUpiAccounts function to fetch the updated list of UPI accounts.

   JavaKotlin

   copy

   razorpay.upiTurbo.getLinkedUpiAccounts(<10 digit mobile number / random customer id>, 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 an OnError with a DEVICE_BINDING_INCOMPLETE error code.

   Request Parameters

   customerMobile

   mandatory

   string The customer's mobile number.

   listener

   object The listener to be sent should be of type UpiTurboResultListener.

   Response Parameters

   onSuccess

   This function is triggered if the list is fetched successfully. accList can be empty to indicate that no accounts have been linked yet.

   onError

   This function is triggered in case an error is thrown during the retrieval process, either by the Razorpay SDK or the Bank SDK.

1.4 Onboarding Flow

Invoke the below function for these use cases:

1. To initiate new onboarding, in case you get a DEVICE_BINDING_INCOMPLETE error in the above section,

2. To link additional bank accounts for already onboarded users.

   JavaKotlin

   copy

   razorpay.upiTurbo.linkNewUpiAccount({10 digit mobile number / random customer id}, 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 SELECT_BANK:
                   if (action.getError() != null) {
                       return;
                   }
                   if (action.getData() != null && action.getData() instanceof AllBanks) {
                       AllBanks allBanks = (AllBanks) action.getData();
                       List < Bank > popularBanks = allBanks.getPopularBanks();
                       List < Bank > allBanksList = allBanks.getBanks();
                       //show dialog with bank list
                       action.selectedBank(popularBanks.get(0));
                   }
                   break;
               case SELECT_BANK_ACCOUNT:
                   if (action.getError() != null) {
                       return;
                   }
                   if (action.getData() != null && action.getData() instanceof List) {
                       List << ? > bankAccountList = (List << ? > ) action.getData();
                       if (bankAccountList.get(0) instanceof BankAccount) {
                           //Show dialog with bank account list
                           action.selectedBankAccount((BankAccount) bankAccountList.get(0));
                       }
                   }
                   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((UpiAccount) onboardedUpiAccounts.get(0));
                   }
                   break;
               case LOADER_DATA:
                   //Use this trigger to easily show background process happening in the SDK during onboarding
                   showLoaderData((String) action.getData());
                   break;
           }
       }
   });

Transactional Flow

1. To process the payments, call the submit method of custom checkout with the provided payload.

   JavaKotlin

   copy

   try {
          JSONObject payload = new JSONObject();
           payload.put("currency", "INR");
           payload.put("amount", "700");
           payload.put("email", "gaurav.kumar@example.com");
           payload.put("contact", "9000090000");
           payload.put("method", "upi");
   
           // Creating the nested "upi" object
           JSONObject upiObject = new JSONObject();
           upiObject.put("flow", "in_app");
   
           payload.put("upi", upiObject);
           payload.put("order_id", "order_L2MUBUOeFItcpU");
           payload.put("customer_id", "cust_KQlMczYKcDIqmB"); // Optional
   
       } catch (Exception e) {
           e.printStackTrace();
       }

2. Pass the vpa and payload objects as shown in the code below.

   Function call

   copy

   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) {
           
       }
       @Override
       public void onPaymentError(int code, String response, PaymentData paymentData) {
           //Show error message
       }
   });

Non-Transactional Flow

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

razorpay.upiTurbo?.manageUpiAccounts("9999999999",
    object : UpiTurboManageAccountListener {
        override fun onError(error: JSONObject)  {
            /*Throws error if UPI Turbo cannot be initialized or throws error*/}

        override fun onSuccess(data: Any) {/*Can be safely ignored*/}
})

Additional Features

1. To get the device binding status, please use the method isDeviceOnboarded() which returns a boolean. It indicates whether the device binding, which is a prerequisite for adding UPI accounts, is done with the user's mobile number.

   Kotlin

   copy

   if (Razorpay.UpiTurbo.isDeviceOnboarded(activity: Activity)) {
       // User Device Binded
   } else {
       // Call Link New Account for Device Binding
   }

2. Users can now link their credit cards alongside bank accounts during onboarding. You can seamlessly retrieve both credit and bank accounts for transactions, thereby simplifying payments, expanding options, and ensuring security.

3. Charges will be levied for payments made using CC on UPI. Contact the

   support team

   for further information.

Models Exposed from the SDKs

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

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 allowlisted by Razorpay to test on prod.

• As a compliance requirement, you need to get approval from Google for READ_SMS permission. Refer

  to the Google article

  for more details.

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