# FinBox Lending: React Native

FinBox Lending React Native SDK is a wrapper around the Android and IOS SDK which helps add a digital lending journey to any mobile application.

# Requirements

FinBox Lending SDK works on Android 5.0+ (API level 21+), Java 8+ and AndroidX. In addition to the changes, enable desugaring to support older versions.

Kotlin
Groovy

android {
    ...
    defaultConfig {
        ...
        // Minimum 5.0+ devices
        minSdkVersion(21)
        ...
    }
    ...
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled = true
        // Sets Java compatibility to Java 8
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    // For Kotlin projects
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

dependencies {
    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.1.5")
}

# Add Plugin

Specify the following in local.properties file:

ACCESS_KEY=<ACCESS_KEY>
SECRET_KEY=<SECRET_KEY>
LENDING_SDK_VERSION=<LENDING_SDK_VERSION>

In the project level build.gradle file or settings.gradle, add the repository URLs to all allprojects block or repositories block inside dependencyResolutionManagement.

Kotlin
Groovy

maven {
    setUrl("s3://risk-manager-android-sdk/artifacts")
    credentials(AwsCredentials::class) {
        accessKey = <ACCESS_KEY>
        secretKey = <SECRET_KEY>
    }
    content {
        includeGroup("in.finbox.lending")
    }
}

Add plugin dependency

NPM
Yarn

yarn add react-native-finbox-middleware-sdk

NOTE

Following will be shared by FinBox team at the time of integration:

ACCESS_KEY
SECRET_KEY
LENDING_SDK_VERSION
CLIENT_API_KEY

# Build Lending

Build the FinBoxMiddlewareSdk object by passing environment, apiKey, customer_id, user_token and others.

// Build Lending
FinBoxMiddlewareSdk.buildLending(
    "ENVIRONMENT", 
    "CLIENT_API_KEY", 
    "CUSTOMER_ID", 
    "USER_TOKEN", 
    AMOUNT,                 // Required only for Creditline Flow
    "ORDER_ID",             // Required only for Creditline Flow
    "UTM_SOURCE",           // Optional: UTM Source
    "UTM_CONTENT",          // Optional: UTM Content
    "UTM_MEDIUM",           // Optional: UTM Medium
    "UTM_CAMPAIGN",         // Optional: UTM Campaign Name
    "UTM_PARTNER_NAME",     // Optional: UTM Partner Name
    "UTM_PARTNER_MEDUIM",   // Optional: UTM Partner Medium
);

Builder Property	Description	Required
`environment`	specifies the `prod` or `uat` environment	Yes
`apiKey`	specifies the unique id shared with the client	Yes
`customerId`	specifies the unqiue id for the customer	Yes
`userToken`	specifies the unique token generated for the session	Yes
`creditLineAmount`	Amount used for Creditline Journey	No
`creditLineTransactionId`	Transaction id for the Creditline Journey	No
`utmSource`	UTM Source	No
`utmContent`	UTM Content	No
`utmMedium`	Medium of the UTM campaign	No
`utmCampaign`	Name of the UTM campaign	No
`utmPartnerName`	Name of the UTM partner	No
`utmPartnerMedium`	Medium of the UTM partner	No

# Show SDK Screen

Start Lending Screen and listen for the result

FinBoxMiddlewareSdk.startLendingJourney((error: any) => {
      // Error Callback
   },
   (resultCode) => {
      // Success Callback
   });

# Parse Results

Once the user navigates through and completes the lending journey, the sdk automatically closes FinBoxMiddlewareSdk and returns the results.

Success callback contains resultCode.

Possible values for resultCode are as follows:

Result Code	Description
`MW200`	Journey is completed successfully
`MW500`	User exits the journey
`MW400`	Some error occurred in the SDK
`CL200`	Credit line withdrawal success
`CL500`	Credit line withdrawal failed

← Android Flutter →