--- page_title: Installing the SDK product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/getting-the-sdk/getting-sdk llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## Installing the SDK For using the services provided by the SDK, client needs to implement certain APIs exposed by the SDK. These APIs are available through the SDK. It is a build time dependency which exposes certain classes for use across your application. To install the SDK follow the below steps: ### Step 1 Add SDK maven url The maven url specifies from where the SDK dependency should be downloaded. It should be present inside the `allProjects/repositories` section of your project build.gradle. > **Warning** > Make sure it is added to project dependency section. **(eg: build.gradle (Project:ProjectName))** #### Code Snippets: - #### Java Code Snippet: ```java maven { url "https://maven.juspay.in/jp-build-packages/hyper-sdk/" } ``` #### Kotlin Code Snippet: ```kotlin maven { url "https://maven.juspay.in/jp-build-packages/hyper-sdk/" } ``` ### Step 2 Add SDK implementation To inject SDK as dependency in your application, include it in your `application build.gradle` dependencies. #### Code Snippets: - #### Java Code Snippet: ```java hyperSdkPlugin { clientId = "" // shared by Juspay Team sdkVersion = "2.2.6" } ``` #### Kotlin Code Snippet: ```kotlin hyperSdkPlugin { clientId = "" // shared by Juspay Team sdkVersion = "2.2.6" } ``` ### Step 3.1 (Optional) Add Shimmer This is required only if shimmer effect is to be used in your application. #### Code Snippets: - #### Java Code Snippet: ```java implementation('com.facebook.shimmer:shimmer:0.5.0') ``` #### Kotlin Code Snippet: ```kotlin implementation('com.facebook.shimmer:shimmer:0.5.0') ``` ### Step 3.2.1 Add secure component (Sandbox) Include the secure component dependency in your `application build.gradle` under dependencies section. #### Code Snippets: - #### Java Code Snippet: ```java implementation'in.juspay:secure-component-uat:4.1.8' ``` #### Kotlin Code Snippet: ```kotlin implementation'in.juspay:secure-component-uat:4.1.8' ``` ### Step 3.2.2 Add secure component (Production) Include the secure component dependency in your `application build.gradle` under dependencies section. #### Code Snippets: - #### Java Code Snippet: ```java implementation "in.juspay:secure-component-prod:4.1.8" ``` #### Kotlin Code Snippet: ```kotlin implementation "in.juspay:secure-component-prod:4.1.8" ``` ### Sync Project > **Warning** > **After adding Assets Plugin and Hyper SDK to your project, please ensure you do a gradle sync and clean build** --- ## Complete Code Reference The following code files are referenced in the steps above: ### build.gradle ``` plugins { id 'com.android.application' // block:start:asset-plugin id 'hypersdk.plugin' //block:end:asset-plugin } android { compileSdk 31 defaultConfig { applicationId "in.juspay.devtools" minSdk 21 targetSdk 31 versionCode 1 versionName "1.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' } } compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } // block:start:add-sdk-implementation hyperSdkPlugin { clientId = "" // shared by Juspay Team sdkVersion = "2.2.6" } // block:end:add-sdk-implementation dependencies { // block:start:add-shimmer implementation('com.facebook.shimmer:shimmer:0.5.0') // block:end:add-shimmer // block:start:scanner-sdk implementation "com.google.mlkit:barcode-scanning:17.3.0" implementation "androidx.camera:camera-core:1.4.2" implementation "androidx.camera:camera-camera2:1.4.2" implementation "androidx.camera:camera-lifecycle:1.4.2" implementation "androidx.camera:camera-view:1.4.2" // block:end:scanner-sdk // block:start:add-secure-component implementation'in.juspay:secure-component-uat:4.1.8' // block:end:add-secure-component // block:start:add-secure-component-prod implementation "in.juspay:secure-component-prod:4.1.8" // block:end:add-secure-component-prod } ``` ### build(sbx).gradle ``` plugins { id 'com.android.application' id 'hypersdk.plugin' //Remove in case of flutter integration } android { compileSdk 31 defaultConfig { applicationId "in.juspay.devtools" minSdk 21 targetSdk 31 versionCode 1 versionName "1.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' } } compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } // hyperSdkPlugin block has to be excluded for flutter // block:start:add-sdk-implementation-sbx hyperSdkPlugin { clientId = ""// shared by Juspay Team sdkVersion = "2.2.6" } // block:end:add-sdk-implementation-sbx dependencies { // block:start:add-secure-component implementation'in.juspay:secure-component-uat:4.1.8' // block:end:add-secure-component // block:start:add-secure-component-prod implementation "in.juspay:secure-component-prod:4.1.8" // block:end:add-secure-component-prod // block:start:scanner-sdk implementation "com.google.mlkit:barcode-scanning:17.3.0" implementation "androidx.camera:camera-core:1.4.2" implementation "androidx.camera:camera-camera2:1.4.2" implementation "androidx.camera:camera-lifecycle:1.4.2" implementation "androidx.camera:camera-view:1.4.2" // block:end:scanner-sdk } ``` ### build.gradle ``` // Top-level build file where you can add configuration options common to all sub-projects/modules. buildscript { repositories { google() mavenCentral() // block:start:assets-plugin-maven-url maven { url "https://maven.juspay.in/jp-build-packages/hyper-sdk/" } // block:end:assets-plugin-maven-url } dependencies { classpath "com.android.tools.build:gradle:7.0.0" // block:start:assets-class-path classpath 'in.juspay:hypersdk.plugin:2.0.6' // block:end:assets-class-path // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files } } allprojects { repositories { google() mavenCentral() // block:start:hyper-sdk-maven-url maven { url "https://maven.juspay.in/jp-build-packages/hyper-sdk/" } // block:end:hyper-sdk-maven-url } } task clean(type: Delete) { delete rootProject.buildDir } ``` --- ## See Also - [Integration Checklist](https://juspay.io/in/docs/upi-tpap-sdk/android/overview/integration-checklist) - [Installing Assets Plugin](https://juspay.io/in/docs/upi-tpap-sdk/android/getting-the-sdk/adding-plugin)