Integrate Turbo UPI Headless

1. Integration Steps

1. Use the code given below to initialise the SDK.

   Import Package

   copy

   import 'package:razorpay_flutter/razorpay_flutter.dart'; 
    // Create a Razorpay instance
   razorpay = Razorpay("YOUR_KEY_ID");

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

   Link UPI Account

   copy

   razorpay.upiTurbo.linkNewUpiAccount("mobileNumber");

   Request Parameter

   Parameter	Description
   mobileNumber	Mobile number of the customer.

   • Initialise the instance to handle the event using the code given below:
   Instantiate

   copy

   razorpay.on(Razorpay.EVENT_UPI_TURBO_LINK_NEW_UPI_ACCOUNT,
   _handleLinkNewUpiAccountFlows);

   • Handle dynamic responses to perform specific actions, including error handling and interactions with the integration, based on 'type' and 'action' properties.
   Watch Out!

   It is mandatory to add the import statement within the linkNewUpiAccount function for RazorpayCard access.

   Attach Event Listeners

   copy

   import 'package:razorpay_flutter_customui/card.dart' as RazorPayCard;
   
   void _handleLinkNewUpiAccountFlows(dynamic response) {
    if (response["error"] != null) {
       Error error = response["error"];
       error.errorCode;
       error.errorDescription;
       return;
   }
   
   switch (response["action"]) {
    case "ASK_FOR_PERMISSION":
       razorpay.upiTurbo.askForPermission();
       break;
    case "LOADER_DATA":
       / Use this trigger to easily show background process happening in the SDK during onboarding
       break;
    case "STATUS":
       razorpay.upiTurbo.getLinkedUpiAccounts(
           customerMobile: mobileNumber,
           onSuccess: (List<UpiAccount> upiAccounts) {},
           onFailure: (Error error) {},
       );
       break;
    case "SELECT_SIM":
       List<Sim> sims = response["data"];
       // Show dialog with a list of sims
       razorpay.upiTurbo.register(sim: sims[0]);
       break;
    case "SELECT_BANK":
       AllBanks allBank = response["data"];
       List<Bank> popularBanks = allBank.popularBanks;
       List<Bank> banks = allBank.banks;
   
       // Show dialog with bank list
       razorpay.upiTurbo.getBankAccounts(bank: banks[0]);
       break;
    case "SELECT_BANK_ACCOUNT":
       List<BankAccount> bankAccounts = response["data"];
       razorpay.upiTurbo.selectedBankAccount(bankAccount: bankAccounts[0]);
       break;
    case "SETUP_UPI_PIN":
       var card = RazorPayCard.Card(
           lastSixDigits: lastSixDigits,
           expiryYear: expiryYear,
           expiryMonth: expiryMonth,
       );
       razorpay.upiTurbo.setupUpiPin(card: card);
       break;
    default:
     // Wrong action message
    }
   }

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

   Get Linked UPI Account

   copy

   razorpay.upiTurbo.getLinkedUpiAccounts(customerMobile: mobileNumber,
     onSuccess: (List<UpiAccount> upiAccounts){
        //Display on boarded UpiAccounts.     
     },
     onFailure: (Error error) {
        //Display error message to user.             
     }
   );

   Request Parameter

   Parameter	Description
   mobileNumber	Mobile number of the customer.

   Response Parameters

   Parameter	Description
   onSuccess	This function is triggered if the list is fetched successfully. accList can be empty to indicate that no accounts have been linked yet.
   onFailure	This function is triggered in case an error is thrown during the retrieval process, either by the Razorpay SDK or the Bank SDK.

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

   Submit Payment Details

   copy

   Map<String, dynamic> payload = {
    "key": "[YOUR_KEY_ID]",
    "currency": "INR",
    "amount": 100,
    "contact": "9000090000",
    "method": "upi",
    "email": "gaurav.kumar@example.com",
    "upi": {
        "flow": "in_app"
    }
   };
   
   Map<String, dynamic> turboPayload = {
    "upiAccount": getUpiAccountStr(upiAccounts[0]),
    "payload": payload,
   };
   
   String getUpiAccountStr(UpiAccount upiAccount) {
       return jsonEncode(UpiAccount(
           accountNumber: upiAccount.accountNumber,
           bankLogoUrl: upiAccount.bankLogoUrl,
           bankName: upiAccount.bankName,
           bankPlaceholderUrl: upiAccount.bankPlaceholderUrl,
           ifsc: upiAccount.ifsc,
           pinLength: upiAccount.pinLength,
           vpa: upiAccount.vpa,
       ).toJson());
   }
   
   razorpay.submit(turboPayload);

   Request Parameter

   Parameter	Description
   turboPayload	Payload for initiating transaction.

   Response Parameters

   Parameter	Description
   onSuccess	This function is triggered if the list is fetched successfully. accList can be empty to indicate that no accounts have been linked yet.
   onFailure	This function is triggered in case an error is thrown during the retrieval process, either by the Razorpay SDK or the Bank SDK.

   • Initialise the instance to handle the event, using the code given below:
   Instantiate

   copy

   razorpay.on(Razorpay.EVENT_PAYMENT_SUCCESS, _handlePaymentSuccess);
   razorpay.on(Razorpay.EVENT_PAYMENT_ERROR, _handlePaymentError);

   • Print payment success and error responses by attaching event listeners to payment events as given below:
   Attach Event Listeners

   copy

   void _handlePaymentSuccess(Map<dynamic, dynamic> response) {
       print('Payment Success Response : $response');
   }
   
   void _handlePaymentError(Map<dynamic, dynamic> response) {
       print('Payment Error Response : $response');
   }

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: upiAccount,
    onSuccess: (AccountBalance accountBalance){
    },
    onFailure: (Error error) {
    }
);

razorpay.upiTurbo.changeUpiPin(upiAccount: upiAccount,
    onSuccess: (UpiAccount upiAccount){
    },
    onFailure: (Error error) {
    }
);

razorpay.upiTurbo.resetUpiPin(upiAccount: upiAccount, card: card,
    onSuccess: (UpiAccount upiAccount){
    },
    onFailure: (Error error) {
    }
);

razorpay.upiTurbo.delink(upiAccount: upiAccount,
    onSuccess: (Empty empty){
    },
    onFailure: (Error error) {
    }
);

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:

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

2. Import the prod library from the Github repository → https://github.com/upi-turbo/android-turbo-sample-app/tree/prod/app/libs prod branch.

3. 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.** { *; }

4. Replace the UAT credential with the

   Razorpay live keys

   for prod testing.