Integrate Turbo UPI Headless

1. Integration Steps

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

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

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

   copy

   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. 
           }
         }
   });

   Request Parameters

   customerMobile

   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.

   • If the customer has not linked any 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.
   JavaKotlin

   copy

   razorpay.upiTurbo.linkNewUpiAccount("<CUSTOMER_MOBILE>", 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;
       }
   }
   });

   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

   .

   Handy Tips

   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 of the 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.

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

   JavaKotlin

   copy

   JSONObject payload = new JSONObject();
   payload.put("currency", "INR");
   payload.put("email", "gaurav.kumar@example.com");
   payload.put("contact", "9999999999");
   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");//optional
   payload.put("customer_id", "cust_KQlMczYKcDIqmB");//optional

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

   JavaKotlin

   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) {
           //show success message
       }
       @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.getBalance(upiAccount, new Callback<AccountBalance>() {
@Override
public void onSuccess(AccountBalance accountBalance) {
}

@Override
public void onFailure(@NonNull Error error) {
}
});

razorpay.upiTurbo.changeUpiPin(upiAccount, new Callback<UpiAccount>() {
@Override
public void onSuccess(UpiAccount upiAccount) {
}

@Override
public void onFailure(@NonNull Error error) {
}
});

razorpay.upiTurbo.resetUpiPin(card, upiAccount, new Callback<Empty>() {
@Override
public void onSuccess(Empty empty) {
}

@Override
public void onFailure(@NonNull Error error) {
}
});

razorpay.upiTurbo.delink(upiAccount, new Callback<Empty>() {
@Override
public void onSuccess(Empty empty) {
}

@Override
public void onFailure(@NonNull Error error) {  
}
});

Additional Features

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

   JavaKotlin

   copy

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

2. 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 comes back, the payment process starts from the beginning.

   JavaKotlin

   copy

   @Override
   public void onBackPressed() {
       razorpay.onBackPressed();
       razorpay.upiTurbo.destroy();
       super.onBackPressed();
   }

3. To get the device binding status, please use the variable razorpay.upiTurbo.deviceBindingDone of type 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.deviceBindingDone){
   //show UI, which indicates device binding with the customer's mobile is pending
   }else{
   //proceed with getLinkedUpiAccounts
   }

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