@pinwheel/react-native-pinwheel

v3.2.0-rc.6

Published

16 hours ago

Pinwheel React Native SDK

Downloads

15,982

react-native-pinwheel

Pinwheel SDK for React Native

Installation

Install Pinwheel React Native SDK

$ npm install --save @pinwheel/react-native-pinwheel

Configuration

Some platform integrations may require camera access for verification purposes. Ensure the necessary permissions are configured in your project:

Android: Add the following permission to your AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA" />

iOS: Add the following key and description to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>We need access to your camera for verification purposes.</string>

Usage

Link Token

To initialize Link Modal, a short-lived link token will need to be generated first. Your server can generate the link token by sending a POST request to the /v1/link_tokens endpoint. DO NOT ever send this request from the client side and publicly expose your api_secret.

The link token returned is valid for one hour, after which it expires and can no longer be used to initialize Link. The expiration time is returned as a unix timestamp.

Pinwheel Component

The PinwheelLink component is a view that you can integrate into your app's flow like so:

import PinwheelLink from "@pinwheel/react-native-pinwheel";

<PinwheelLink
  linkToken={response.data.token}
  onLogin={result => { /* ... */ }}
  onError={error => { /* ... */ }}
  onSuccess={result => { /* ... */ }}
  onExit={error => { /* ... */ }}
  onEvent={(eventName, payload) => { /* ... */ }}
/>;

With the PinwheelLink component, end-users can select their employer, authenticate with their payroll platform login credentials, and authorize the direct deposit change. Throughout the authorization process, events will be emitted to the onEvent callback and any errors (both user errors such as invalid parameters and any system errors which arise) will be emitted to the onError callback. Upon a successful login, onLogin will be called and once the full flow is complete the onSuccess callback will be called. onExit will be called when the Pinwheel modal is closed, and you should remove the PinwheelLink component from your view hierarchy.

Props

`linkToken`

The link token retrieved using the create link token endpoint.

| Type | Required | | ------ | -------- | | string | Yes |