# BankConnect: Ionic Capacitor

Bank Connect Ionic Capacitor SDK helps user submits their bank statements via upload or net banking credentials in your Android application.

# Requirements

Bank Connect 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")
}
 
        Copied!

# Add Plugin

Specify the following in local.properties file:

ACCESS_KEY=<ACCESS_KEY>
SECRET_KEY=<SECRET_KEY>
BC_SDK_VERSION=<BC_SDK_VERSION>
 
        Copied!

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.bankconnect")
    }
}
 
        Copied!

Add plugin dependency

NPM
Yarn

yarn add ionic-bank-connect-sdk
 
        Copied!

NOTE

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

ACCESS_KEY
SECRET_KEY
BC_SDK_VERSION
CLIENT_API_KEY

# Integration Workflow

The diagram below illustrates the integration workflow in a nutshell: Client SDK Workflow

# Sample Project

We have hosted a sample project on GitHub, you can check it out here:

Open GitHub Repository

# Build Bank Connect

Build the IonicBankConnectSdk object by passing apiKey, linkId, fromDate, toDate, bank, mode and others.

// Build BankConnect
IonicBankConnectSdk.buildBankConnect(options: {
    apiKey: "CLIENT_API_KEY",
    linkId: "LINK_ID",
    fromDate: "FROM_DATE",                                          // Optional: Default 6 months old date
    toDate: "TO_DATE",                                              // Optional: Default value 1 day less than current date
    bank: "BANK_NAME",                                              // Optional: Short code of the bank
    mode: "MODE",                                                   // Optional: PDF Mode
    mobileNumber: "MOBILE_NUMBER",                                  // Optional: Mobile number
    journeyMode: "JOURNEY_MODE",                                    // Optional: Multi PDF journey
    aaJourneyMode: "AA_JOURNEY_MODE",                               // Optional: Recurring AA pulls
    aaRecurringTenureMonthCount: "AA_RECURRING_TENURE_MONTH_COUNT", // Optional: Consent duration is valid for 3 months
    aaRecurringFrequencyUnit: "AA_RECURRING_FREQUENCY_UNIT",        // Optional: Frequency value is in Days
    aaRecurringFrequencyValue: "AA_RECURRING_FREQUENCY_VALUE",      // Optional: Number of times to pull the data
});
 
        Copied!

Builder Property	Description	Required
`apiKey`	specifies the `api_key`	Yes
`linkId`	specifies the `link_id`	Yes
`fromDate`	specifies the starting period of the statement in `DD/MM/YYYY`format	No
`toDate`	specifies the end period of the statement in `DD/MM/YYYY` format	No
`bank`	pass the bank identifier to skip the bank selection screen and directly open a that bank's screen instead	No
`mode`	set the mode as pdf (manual upload) or aa (Account Aggregator) or online (Net Banking)	No
`mobile_number`	Prefills phone number in Account Aggregator mode	No
`journey_mode`	Optional parameter to set the journey (i.e.multi_pdf or multi_banking)	No
`aa_journey_mode`	set the journey mode for AA (i.e only_once or only_recurring)	No
`aa_recurring_tenure_month_count`	set the recurring consent duration (min: 1 and max: 24)	No
`aa_recurring_frequency_unit`	set the frequency unit to pull the data during the recurring consent duration (year, month, day, hour)	No
`aa_recurring_frequency_value`	set the frequency value to pull the data during the recurring consent duration (min: 1 and max: 3)	No

fromDate and toDate specify the period for which the statements will be fetched. For example, if you need the last 6 months of statements, fromDate will be today's date - 6 months and toDate will be today's date - 1 day. If not provided the default date range is 6 months from the current date. It should be in DD/MM/YYYY format.

Once the above statement is added, a series of checks are done to make sure the SDK is implemented correctly. A RunTimeException will be thrown while trying to build the project in case any of the checks are not completed.

Minimal Requirements for SDK to work:

apiKey is is mandatory
linkId is mandatory, and should be at least 8 characters long
In case fromDate / toDate is provided, make sure they are of correct date format: DD/MM/YYYY.
Make sure fromDate is always less than toDate
Make sure toDate is never today's date, the maximum possible value for it is today's date - 1 day Once all these conditions are met, the BankConnect object will build.

# Show SDK Screen

Start Bank Screen and listen for the result

// Show BankConnect UI
IonicBankConnectSdk.showBankConnect((error: any) => {
    // error callback
  }, (entityId: any, sessionId: any) => {
    // Success callback
  });
 
        Copied!

# Parse Results

Once the user navigates through the banks and uploads the bank statement, the sdk automatically closes IonicBankConnectSdk and returns the results.

Success callback contains entityId (or sessionId). A successful upload contains a unique entityId (or sessionId).

entityId - Unique id of a successful statement upload during Entity flow
sessionId - Session id of a successful statement upload during Session flow

← Cordova IOS →