Getting Started

In your react-native project directory:

npm install --save react-native-plaid-link-sdk

Versions and release candidates

We create release candidates (e.g. 7.0.0-rc1) as beta previews for developers. These are helpful for customers who either are 1. waiting for a specific fix or 2. extremely eager for specific features. They do not hold the same quality guarantee as our official releases, and should NOT be used in production. The official releases come ~2 weeks after the first release candidate (rc1).

The latest stable version is the highest version without the suffix -rcX.

Updating from previous versions.

When upgrading from a previous major version of this library, see the following notes for additional instructions:

Upgrading pre 5.x
Upgrading from 5.x onwards

iOS

Add Plaid to your project’s Podfile as follows (likely located at ios/Podfile). The latest version is .

pod 'Plaid', '~> <insert latest version>'

Then install your cocoapods dependencies:

(cd ios && pod install)

Add a Run Script build phase (after the [CP] Embed Pods Frameworks step) to your target as described in Plaid Link for iOS documentation. This strips simulator symbols from App Store release builds.

That's it if using a recent react-native version with autolinking support.

Manual Integration

If using a version of react-native without autolinking support, then you will need to:

react-native link react-native-plaid-link-sdk

followed by

In Xcode, in the project navigator, right click Libraries ▶ Add Files to [your project's name]
Go to node_modules ▶ react-native-plaid-link-sdk ▶ ios and add RNLinksdk.xcodeproj
In Xcode, in the project navigator, select your project. Add libRNLinksdk.a to your project's Build Phases ▶ Link Binary With Libraries
Run your project (Cmd+R)<

Android

1. Register your app id

Log into your Plaid Dashboard at the API page
Next to Allowed Android package names click "Configure" then "Add New Android Package Name"
Enter your package name, for example com.plaid.example
Click "Save Changes", you may be prompted to re-enter your password

2. Add PlaidPackage to your application

Go to android/app/src/main/java/<AppName>/MainApplication.java
Add import com.plaid.PlaidPackage; to the imports section
Add packages.add(new PlaidPackage()); to List<ReactPackage> getPackages();

Plaid Link React Native SDK

For a full guide and migration guides please vist our docs

3. Configure Gradle

Go to the project level android/app/build.gradle
Make sure you are using a min sdk >= 21
Add the following dependencies:

dependencies {
    // ...
    implementation project(':react-native-plaid-link-sdk')
}

Go to android/settings.gradle
Add the following lines:

include ':react-native-plaid-link-sdk'
project(':react-native-plaid-link-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-plaid-link-sdk/android')

Version Compatibiltiy

React Native SDK	Android SDK	iOS SDK	Status
7.x.x	[3.2.0+]	>=2.0.7	Active
6.x.x	[3.0.0-3.2.0)	>=2.0.1	Active
5.x.x	[2.1.0-3.0.0)	>=1.1.34	Active
4.x.x	[2.0.0-2.1.0)	<=1.1.33	Active
3.x.x	[1.0.0-2.0.0)	<=1.1.33	Deprecated
2.x.x	[0.3.0-1.0.0)	<=1.1.27	Deprecated
1.x.x	[0.1.0-0.3.0)	<=1.1.24	Deprecated

PlaidLink

To initialize PlaidLink, you will need to first create a link_token at /link/token/create. After creating a link_token, you'll need to pass it into your app and use it to launch Link:

import { Text } from 'react-native';
import { PlaidLink, LinkSuccess, LinkExit } from 'react-native-plaid-link-sdk';

const MyPlaidComponent = () => {
  return (
    <PlaidLink
        tokenConfig={{
            token: "#GENERATED_LINK_TOKEN#",
        }}
        onSuccess={(success: LinkSuccess) => { console.log(success) }}
        onExit={(exit: LinkExit) => { console.log(exit) }}
    >
        <Text>Add Account</Text>
    </PlaidLink>
  );
};

PlaidLink wraps the view you provide as a child with a Pressable component and intercepts the onPress event.

OAuth requirements

For Link Token based OAuth support, you must configure your link_token with a redirect_uri to support OAuth on iOS. Other than setting the redirect_uri, which must be a universal link, when you create the link_token no further configuration is required. Notably, no props are required on the React Native side.

For non-Link Token based OAuth support, you must pass two props to the PlaidLink React Native component:

oauthRedirectUri this is the same uri you would pass to the redirect_uri for Link Token based OAuth. It must be registered as a universal link.
oauthNonce this is a 16 character nonce.

In order for the React Native app to respond to the universal link, you will need to update your AppDelegate to inform the React Native Linking library when the universal link is received. See OAuth requirements for more information.

To receive onEvent callbacks:

The React Native Plaid module emits onEvent events throughout the account linking process — see details here. To receive these events in your React Native app, wrap the PlaidLink react component with the following in order to listen for those events:

import React from 'react';
import { Text, NativeEventEmitter, NativeModules, Platform } from 'react-native';

class PlaidEventContainer extends React.Component {

  componentDidMount() {
    const emitter = new NativeEventEmitter(Platform.OS === 'ios' ? NativeModules.RNLinksdk : NativeModules.PlaidAndroid);
    this._listener = emitter.addListener('onEvent', (e) => console.log(e));
  }

  componentWillUnmount() {
    if (this._listener) {
      this._listener.remove();
    }
  }

  ...
}

You can also use the usePlaidEmitter hook in react functional components:

  usePlaidEmitter((event: LinkEvent) => {
    console.log(event)
  })

numandev1/react-native-plaid-link-sdk