react-native-smallcase-gateway

📖 Complete Guide

Getting started

$ yarn add react-native-smallcase-gateway

or

$ npm install react-native-smallcase-gateway

ios setup

add these lines at the top of your Podfile

# private podspec for smallcase
source 'git@github.com:smallcase/cocoapodspecs.git'

# default source for all other pods
source 'https://cdn.cocoapods.org'

# update the ios version if it was previously below 11.0
platform :ios, '11.0'

then run cd ios; pod update

android setup

Add these lines to your project level build.gradle

allprojects {
    repositories {
        // .. you other repositories
        maven {
          url "http://artifactory.smallcase.com/artifactory/gradle-dev-local"
          credentials {
            username "react_native_user"
            password "reactNativeUser123"
          }
      }
    }
}

add these lines in AndroidManifest.xml in the main <application /> tag

<activity android:name="com.smallcase.gateway.screens.transaction.activity.TransactionProcessActivity">
  <intent-filter>
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.BROWSABLE" />
    <category android:name="android.intent.category.DEFAULT" />
    <data
      android:host="{YOUR_HOST_NAME}"
      android:scheme="scgateway" />
  </intent-filter>
</activity>

<activity android:name="com.smallcase.gateway.screens.common.RedirectActivity">
  <intent-filter>
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.BROWSABLE" />
    <category android:name="android.intent.category.DEFAULT" />

    <data
      android:host="{YOUR_HOST_NAME}"
      android:scheme="scgatewayredirect"
    />
  </intent-filter>
</activity>

Example Usage

// import gateway into your file
import SmallcaseGateway from "react-native-smallcase-gateway";

// configure environment
await SmallcaseGateway.setConfigEnvironment({
  isLeprechaun: true,
  isAmoEnabled: true,
  gatewayName: "smallcase-website",
  environmentName: SmallcaseGateway.ENV.PROD,
  brokerList: ["kite", "aliceblue", "trustline"],
});

// initialize session
await SmallcaseGateway.init(sdkToken);

// execute a transaction
const res = await SmallcaseGateway.triggerTransaction(transactionId);

// start lead generation flow
SmallcaseGateway.triggerLeadGen({ email: "test@gmail.com" });

Incognito Mode

triggerTransaction accepts an optional 4th incognito argument (default false):

// execute a transaction in incognito mode
const res = await SmallcaseGateway.triggerTransaction(
  transactionId,
  utmParams,
  brokerList,
  true // incognito
);

When true, the broker flow opens in a private/ephemeral browsing session:

• No cookies, cache, or login state from the flow persist on the device once it closes.
• Native broker app login (e.g. Kite/Zerodha app-to-app login) is skipped in favor of the in-app web login, even if the broker app is installed and would normally be used.

This is opt-in and fully backward compatible — existing calls to triggerTransaction(transactionId), triggerTransaction(transactionId, utmParams), or triggerTransaction(transactionId, utmParams, brokerList) are unaffected and continue to run in normal (non-incognito) mode.

Known limitations: incognito prevents local browser data from persisting, but it does not (and cannot) override OS-level Password AutoFill suggestions already saved to the device's keychain, and it does not affect the smallcase account's own broker-connection state — once a broker is connected (incognito or not), subsequent transactions for that same account will correctly recognize it as already connected, since that state lives on smallcase's backend, not in local browser storage.

Requires: com.smallcase.gateway:sdk (Android) and SCGateway (iOS) versions with incognito support. Check with the platform SDK release notes for the minimum version once released.

Using incognito for a different (e.g. linked/family) account: incognito: true on its own does not switch which smallcase account the SDK is acting as — it only changes how that call's browser session behaves. To connect or transact on behalf of a different smallcase account than the one currently authenticated, call SmallcaseGateway.init(sdkToken) again with that account's own token before calling triggerTransaction — the same way you would for any account switch, incognito or not.

Debug / Contribution

Make sure you have react native dev environment set up

ios

• remove node_modules in the root directory
• run yarn install in example/
• run pod update in example/ios
• open SmallcaseGateway.xcworkspace in xcode
• run yarn start (important to get symlinks to work)
• run in debug mode
• in xcode, navigate to Pods > Development Pods > react-native-smallcase-gateway
• you can now edit these file directly and test the results on the running app

android without example app

• run yarn install in the root directory
• change directory to android/
• add a file called gradle.properties
• add artifactory_user and artifactory_password
• open this folder in android studio
• let gradle sync complete
• you can now write code with just the android folder in context

android with example app

• run yarn install in example/
• add a file called gradle.properties in example/android
• add these lines

android.useAndroidX=true
android.enableJetifier=true

FLIPPER_VERSION=version_string

artifactory_user=sampleUser
artifactory_password=samplePassword

• run yarn start (important to get symlinks to work)
• run yarn android to build example project for android