react-plaid-link

react-plaid-link

React hooks and components for integrating with Plaid Link

Compatibility

React 16.8-19.x.x

Install

With npm:

npm install --save react-plaid-link

With yarn:

yarn add react-plaid-link

Documentation

Please refer to the official Plaid Link docs for a more holistic understanding of Plaid Link.

Examples

Head to the react-plaid-link storybook to try out a live demo.

See the examples folder for various complete source code examples.

Using React hooks

This is the preferred approach for integrating with Plaid Link in React.

Note: token can be null initially and then set once you fetch or generate a link_token asynchronously.

See full source code examples of using hooks:

• examples/simple.tsx: minimal example of using hooks
• examples/hooks.tsx: example using hooks with all available callbacks
• examples/oauth.tsx: example handling OAuth with hooks
• examples/layer.tsx: example implementing Plaid Layer

import React from 'react';
import { usePlaidLink } from 'react-plaid-link';

// ...

const { open, ready } = usePlaidLink({
  token: '<GENERATED_LINK_TOKEN>',
  onSuccess: (public_token, metadata) => {
    // send public_token to server
  },
});

return (
  <button onClick={() => open()} disabled={!ready}>
    Connect a bank account
  </button>
);

Available Link configuration options

See src/types/index.ts for exported types.

Please refer to the official Plaid Link docs for a more holistic understanding of the various Link options and the link_token.

usePlaidLink arguments

key	type
token	string | null
onSuccess	(public_token: string | null, metadata: PlaidLinkOnSuccessMetadata) => void
onExit	(error: null | PlaidLinkError, metadata: PlaidLinkOnExitMetadata) => void
onEvent	(eventName: PlaidLinkStableEvent | string, metadata: PlaidLinkOnEventMetadata) => void
onLoad	() => void
receivedRedirectUri	string | undefined
cspNonce	string | undefined

public_token is null for flows such as Identity Verification that do not create an Item.

Content Security Policy nonce

If your app uses a nonce-based Content Security Policy, generate a fresh nonce per page response and pass it as cspNonce on usePlaidLink or PlaidEmbeddedLink. Only mount these components once cspNonce is known.

Allow that nonce in script-src, style-src, and style-src-elem. Link still requires style-src-attr 'unsafe-inline' today. You will also need frame-src and connect-src as documented for Link Web; for example:

default-src https://cdn.plaid.com/;
script-src 'nonce-<PAGE_RESPONSE_NONCE>' https://cdn.plaid.com/link/v2/stable/link-initialize.js;
style-src 'nonce-<PAGE_RESPONSE_NONCE>';
style-src-elem 'nonce-<PAGE_RESPONSE_NONCE>';
style-src-attr 'unsafe-inline';
frame-src https://cdn.plaid.com/;
connect-src https://production.plaid.com/;

If you omit cspNonce, behavior is unchanged (including for embedded Link).

const { open, ready } = usePlaidLink({
  token: '<GENERATED_LINK_TOKEN>',
  cspNonce: '<PER_RESPONSE_NONCE>',
  onSuccess: (public_token, metadata) => {
    // send public_token to server
  },
});

usePlaidLink return value

key	type
open	() => void
ready	boolean
submit	(data: PlaidHandlerSubmissionData) => void
error	ErrorEvent | null
exit	(options?: { force?: boolean }, callback?: () => void) => void

For Layer, call submit with either phone_number or date_of_birth. See the complete Layer example and Plaid Layer integration guide.

Handling an invalid Link token

If onExit receives an INVALID_LINK_TOKEN error, fetch a new Link token and update the token in state. usePlaidLink destroys the old Link instance and creates a new one whenever the token changes. See Plaid's guide to handling an invalid Link token for more context.

import React from 'react';
import { PlaidLinkError, usePlaidLink } from 'react-plaid-link';

const [token, setToken] = React.useState<string | null>(null);

const onExit = React.useCallback(async (error: PlaidLinkError | null) => {
  if (error?.error_code === 'INVALID_LINK_TOKEN') {
    setToken(null);
    const response = await fetch('/api/create_link_token', { method: 'POST' });
    const { link_token } = await response.json();
    setToken(link_token);
  }
}, []);

const { open, ready } = usePlaidLink({
  token,
  onExit,
  onSuccess: (public_token, metadata) => {
    // send public_token to server
  },
});

OAuth / opening Link without a button click

Handling OAuth redirects requires opening Link without any user input (such as clicking a button). This can also be useful if you simply want Link to open immediately when your page or component renders.

See full source code example at examples/oauth.tsx

import React from 'react';
import { usePlaidLink } from 'react-plaid-link';

// ...

const { open, ready } = usePlaidLink(config);

// open Link immediately when ready
React.useEffect(() => {
  if (ready) {
    open();
  }
}, [ready, open]);

return <></>;

Using the pre-built component instead of the usePlaidLink hook

If you cannot use React hooks for legacy reasons such as incompatibility with class components, you can use the PlaidLink component.

See full source code example at examples/component.tsx

import React from 'react';
import { PlaidLink } from 'react-plaid-link';

const App extends React.Component {
  // ...
  render() {
    return (
      <PlaidLink
        token={this.state.token}
        onSuccess={this.onSuccess}
        // onEvent={...}
        // onExit={...}
      >
        Link your bank account
      </PlaidLink>
    );
  }
}

TypeScript support

TypeScript definitions for react-plaid-link are built into the npm package. If you have previously installed @types/react-plaid-link before this package had types, please uninstall it in favor of built-in types.