Integrate with Turbo UPI

​

Prerequisites

1. SDK Version Compatibility:
   • Integrate with Razorpay Android Standard SDK. Ensure that you integrate with SDK version 1.6.37 or higher.
2. Import the following frameworks:
   • In the root settings.gradle file, use:
   Kotlin

       dependencyResolutionManagement {
           repositories {
               // ... other repositories ...
               maven {
                   url = uri("https://maven.pkg.github.com/upi-turbo/android-turbo-sample-app")
                   credentials {
                       username = "upi-turbo"
                       password = ""
                   }
               }
           }
       }
   
   • In the library module’s build.gradle, use:
   Kotlin

       dependencies {
           // UAT
           debugImplementation "com.razorpay:checkout-uat:$CHECKOUT_VERSION"
           debugImplementation "com.razorpay:razorpay-turbo-uat:$TURBO_VERSION"
           debugImplementation "com.razorpay:turbo-ui-uat:$TURBO_VERSION"
   
           // Production
           releaseImplementation "com.razorpay:checkout:$CHECKOUT_VERSION"
           releaseImplementation "com.razorpay:razorpay-turbo:$TURBO_VERSION"
           releaseImplementation "com.razorpay:turbo-ui:$TURBO_VERSION"
       }
   
3. Gradle Properties:
   • Add the following lines to your Android project’s gradle.properties file:
     • android.enableJetifier=true
     • android.useAndroidX=true
4. Minimum SDK Version:
   • Keep in check that the minSDKversion for using Turbo UPI is currently 23 and cannot be overwritten.
5. Contact Prefill in Standard Checkout:
   • Standard Checkout should load with the contact prefilled. This contact information is crucial for setting up UPI accounts.
   • Make sure your Checkout options include prefill contact.

​

Onboarding Flow

​

Turbo UI SDK Integration

1. Initialise the Checkout object with the activity parameter to enable Turbo UPI functionality.
   Kotlin

       val checkout = Checkout()
           .upiTurbo(activity) // mandatory
           .setColor("/*color*/ #000000") // optional
   
   ```kotlin: Java 
   Checkout checkout = new Checkout()
       .upiTurbo(activity)//mandatory
       .setColor("/*color*/ #000000" );//optional
   
   
2. Use the following code to link the newly created UPI account with your app. This function can be called from any application section, offering multiple entry points for customers to link their UPI account with your app. Linking it in advance allows customers to pay directly with the linked UpiAccount without repeating the linking process.
   Kotlin

   checkout.upiTurbo?.linkNewUpiAccount("","#000000"/*color - in hex format*/,
        object: GeneralPluginCallback{
   
           override fun onSuccess(upiAccount: UpiAccount){
               // use upiAccount to display data to the User
           }
   
           override fun onError(error: JSONObject){
               // error regarding linking of UpiAccount
           }       
   
   })
   // color parameter in the function can be used to customize the screens in
   // linking process 
   
   ```kotlin: Java
   checkout.upiTurbo.linkNewUpiAccount("", "#000000"/*color - in hex format*/,
       new GeneralPluginCallback(){
   
       @Override
       public void onSuccess(UpiAccount upiAccount){
   
       }
   
       @Override
       public void onError(JSONObject error){
       }
   
   });
   
   

​

Non-Transactional Flow

​

Manage UPI Accounts

• Fetch balance: Check the customer’s account balance.
• Change UPI PIN: Provide the customer the ability to change their UPI PIN.
• Reset UPI PIN: Let your customers reset the PIN for their account.
• Delete the account from the application: Let your customers delink, that is, remove a selected UPI account from your application.

checkout.upiTurbo?.manageUpiAccounts("9000090000", "#000000"/*color - in hex format(nullable)*/, object : GenericPluginCallback {
    override fun onError(error: JSONObject) {
        /* Throws error if Turbo UPI cannot be initialized or throws error */
    }

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

```kotlin: Java
if (checkout.upiTurbo != null) {
    checkout.upiTurbo.manageUpiAccounts("9000090000","#000000"/*color - in hex format(nullable)*/, new GenericPluginCallback() {
        @Override
        public void onSuccess(@NonNull Object data) {
            /* can be safely ignored */
        }

        @Override
        public void onError(@NonNull JSONObject error) {
            /* Throws error if Turbo UPI cannot be initialized or throws error */
        }
    });
}

​

Models Exposed from the SDKs

​

Error

​

Error | Description

• GATEWAY_ERROR: Failure either from the Secure Component or the Bank.
• SERVER_ERROR: Failure at PSP.

  ---

  ​

  errorDescription | Brief description of the error.

  ​

  errorReason | Specifies the specific reason for the error.

  ​

  errorSource | Indicates the origin of the error.

  errorStep | Highlights the stage where the error occurred. Refer to the list of possible error reasons.