Link React Native SDK

PlaidLink is the the React component used to open Link from a React Native application. PlaidLink renders a Pressable component, which wraps the component you provide and intercepts onPress events to open Link.

1<PlaidLink
2  tokenConfig={{
3    token: '#GENERATED_LINK_TOKEN#',
4  }}
5  onSuccess={(success: LinkSuccess) => {
6    console.log(success);
7  }}
8  onExit={(exit: LinkExit) => {
9    console.log(exit);
10  }}
11>
12  <Text>Add Account</Text>
13</PlaidLink>

The method is called when a user successfully links an Item. The onSuccess handler returns a LinkConnection class that includes the public_token, and additional Link metadata in the form of a LinkConnectionMetadata class.

1const onSuccess = (success: LinkSuccess) => {
2  fetch('https://yourserver.com/exchange_public_token', {
3    method: 'POST',
4    body: {
5      publicToken: linkSuccess.publicToken,
6      accounts: linkSuccess.metadata.accounts,
7      institution: linkSuccess.metadata.institution,
8      linkSessionId: linkSuccess.metadata.linkSessionId,
9    },
10  });
11};

The onExit handler is called when a user exits Link without successfully linking an Item, or when an error occurs during Link initialization. The PlaidError returned from the onExit handler is meant to help you guide your users after they have exited Link. We recommend storing the error and metadata information server-side in a way that can be associated with the user. You’ll also need to include this and any other relevant info in Plaid Support requests for the user.

1const onExit = (linkExit: LinkExit) => {
2  supportHandler.report({
3    error: linkExit.error,
4    institution: linkExit.metadata.institution,
5    linkSessionId: linkExit.metadata.linkSessionId,
6    requestId: linkExitlinkExit.metadata.requestId,
7    status: linkExit.metadata.status,
8  });
9};

The onEvent callback is called at certain points in the Link flow. Unlike the handlers for onSuccess and onExit, the onEvent handler is initialized as a global lambda passed to the Plaid class. OPEN events will be sent immediately upon Link’s opening, and remaining events will be sent by the time onSuccess or onExit is called. If you need the exact time when an event happened, use the timestamp property.
The following onEvent callbacks are stable, which means that they will not be deprecated or changed: OPEN, EXIT, HANDOFF, SELECT_INSTITUTION, ERROR, BANK_INCOME_INSIGHTS_COMPLETED, IDENTITY_VERIFICATION_PASS_SESSION, IDENTITY_VERIFICATION_FAIL_SESSION. The remaining callback events are informational and subject to change.

1usePlaidEmitter((event) => {
2  console.log(event);
3});