From 0e1dd029c4e5ec93cd57159444fbff354389d32c Mon Sep 17 00:00:00 2001 From: "ravinder.singh08" Date: Mon, 1 Dec 2025 16:17:03 +0530 Subject: [PATCH] bank connect session flow changes --- docs/.vuepress/config.js | 30 + docs/session-flow/android.md | 97 +- docs/session-flow/fetch-data.md | 22035 ++++++-------------- docs/session-flow/flutter.md | 57 +- docs/session-flow/get-data.md | 4 +- docs/session-flow/ionic-capacitor.md | 232 + docs/session-flow/ios.md | 115 + docs/session-flow/javascript.md | 75 +- docs/session-flow/processing-status.md | 66 +- docs/session-flow/react-native.md | 232 + docs/session-flow/submit-data-backend.md | 92 +- docs/session-flow/submit-data-frontend.md | 28 +- docs/session-flow/submit-data.md | 143 +- docs/session-flow/upload-status.md | 222 +- 14 files changed, 7677 insertions(+), 15751 deletions(-) create mode 100644 docs/session-flow/ionic-capacitor.md create mode 100644 docs/session-flow/ios.md create mode 100644 docs/session-flow/react-native.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 366f11ef..2d39275a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -256,6 +256,36 @@ module.exports = { { title: 'Frontend Integration', path: '/session-flow/submit-data-frontend.html', + children: [ + { + title: 'JavaScript SDK', + path: '/session-flow/javascript.html' + }, + { + title: 'Android SDK', + path: '/session-flow/android.html' + }, + { + title: 'iOS SDK', + path: '/session-flow/ios.html' + }, + { + title: 'React Native SDK', + path: '/session-flow/react-native.html' + }, + { + title: 'Flutter SDK', + path: '/session-flow/flutter.html' + }, + { + title: 'Cordova SDK', + path: '/session-flow/cordova.html' + }, + { + title: 'Ionic/Capacitor SDK', + path: '/session-flow/ionic-capacitor.html' + }, + ] }, { title: 'Backend Integration', diff --git a/docs/session-flow/android.md b/docs/session-flow/android.md index 734f4e59..c655dcf1 100644 --- a/docs/session-flow/android.md +++ b/docs/session-flow/android.md @@ -1,4 +1,5 @@ # BankConnect: Android + The Android SDK helps user submits their bank statements via upload or net banking credentials in your Android application. ## Requirements @@ -70,7 +71,7 @@ dependencies { -## Adding Dependency +## Add Dependency In the project level `build.gradle` file or `settings.gradle`, add the repository URLs to all `allprojects` block or `repositories` block inside `dependencyResolutionManagement`. @@ -132,9 +133,9 @@ implementation('in.finbox.bankconnect:hybrid::release@aar') { - ::: warning NOTE Following will be shared by FinBox team at the time of integration: + - `ACCESS_KEY` - `SECRET_KEY` - `BC_SDK_VERSION` @@ -142,17 +143,20 @@ Following will be shared by FinBox team at the time of integration: ::: ## 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 `FinBoxBankConnect` object by passing `apiKey`, `linkId`, `fromDate`, `toDate` and `bank`. + +Build the `FinBoxBankConnect` object by passing `apiKey`, `linkId`, `fromDate`, `toDate`, `bank`, `mode` and others. - | Builder Property | Description | Required | | - | - | - | | `apiKey` | specifies the `api_key` | Yes | @@ -191,12 +208,20 @@ new FinBoxBankConnect.Builder(getApplicationContext()) | `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](/bank-connect/appendix.html#bank-identifiers) 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. ::: warning Minimal Requirements for SDK to work: + 1. `apiKey` is is mandatory 2. `linkId` is mandatory, and should be at least 8 characters long 3. In case `fromDate` / `toDate` is provided, make sure they are of correct date format: `DD/MM/YYYY`. @@ -206,7 +231,8 @@ Once all these conditions are met, the BankConnect object will build. ::: ## Show SDK Screen -Start BankActivity and listten for the result + +Start BankActivity and listen for the result