Docs
  • What We Do
  • Supported Countries, Payment Methods, and Cryptocurrencies
  • Getting Started
  • Integration Guides
    • API
      • Required Headers
      • Create a User
      • Assign a Deposit Address
      • KYC
      • Link and Verify a Bank Account
        • Re-link Bank Account
        • Update Bank Account
        • Delete Bank Account
      • Transaction Limits
      • Buy Crypto (ACH)
      • Transaction Monitoring
      • Transaction History
    • React Native
      • Installation
      • Session Token and Wallet Signing
      • Preset Order Details
      • Example
      • Reference
      • Release History
      • User experience
        • Sign up
        • Sign in
        • Buy crypto
        • Settings & activity
    • React JS (Beta)
      • Installation
      • Session Token and Wallet Signing
      • Preset Orders
      • Callbacks
      • Theming
      • Example
      • Reference
      • Release History
  • API Reference
    • Endpoints
      • Auth
        • Crypto Wallet
        • Email OTP
        • SMS OTP
      • Activity
      • Bank
      • Client
      • Config
      • Crypto
      • Users
      • Wallets
      • Webhook Registrations
    • Custom Headers
    • Error Codes
    • Types Glossary
    • Postman
    • Open API Specification
    • Webhooks
  • Design Reference
    • UI/UX Starter kit
    • UI Requirements
  • Guides
    • Sandbox Testing
    • User Authentication
    • Link a new Signing Wallet to an Existing User
    • Plaid Bank Linking
      • Plaid OAuth Support
    • Client Dashboard (Alpha)
  • User Support Reference
    • User Account Flags
      • KYC Review
      • Transaction Processing
      • NSFs and Returned Payments
      • Fraud
    • Transactional Emails
Powered by GitBook
On this page

Was this helpful?

  1. Guides

Plaid Bank Linking

PreviousLink a new Signing Wallet to an Existing UserNextPlaid OAuth Support

Last updated 1 year ago

Was this helpful?

Users will link their bank account to Ratio using Plaid. You do not need to set up an account with Plaid.

Note: For detailed examples of the API calls below, check out our API documentation.

If you are building an iOS app you need to provide sandbox and production redirect URIs, so that we can configure Plaid to properly redirect users to your application. If you are building an Android app, you need to provide us with the Android Package Name. These values need to match what you send in yourrequestLink calls

Requesting a Plaid Link Token

The first step in connecting a user's bank account is to request a Link Token from our API, then pass that Link Token into Plaid's SDK.

You now have a link token that looks something like this: link-sandbox-ab12c3d4-0000-123a-987f-26e621c2ee51. This token needs to be provided to Plaid through one of several methods:

SDKs

Below you will find links to the Plaid SDKs used to launch the Plaid bank account authentication flow.

Note: You do not need to sign up for a Plaid account. You will use the link token provided by Ratio in order to initiate the Plaid SDK from within your application.

React Native SDK

  • To install, run: npm install --save react-native-plaid-link-sdk

  • Github Repo (https://github.com/plaid/react-native-plaid-link-sdk)

  • Documentation (https://plaid.com/docs/link/react-native/)

Android SDK

  • Make sure you share your Android package name with Ratio (ex com.plaid.example)

  • Add the SDK to your Gradle file (https://search.maven.org/artifact/com.plaid.link/sdk-core)

  • Github Repo (https://github.com/plaid/plaid-link-android)

  • Documentation (https://plaid.com/docs/link/android/)

iOS SDK

  • Make sure you configure a Universal Link and share the redirect URL with Ratio (https://developer.apple.com/ios/universal-links/)

  • To install with Cocoapods, run: pod 'Plaid', see the documentation for other options.

  • Github Repo (https://github.com/plaid/plaid-link-ios)

  • Documentation (https://plaid.com/docs/link/ios/)

Web (React)

  • To install, run: npm install --save react-plaid-link

  • Github Repo (https://github.com/plaid/react-plaid-link)

  • Documentation (https://plaid.com/docs/link/web/)

Activate the Plaid Link SDK

Now that you have a public token, you can proceed with the next step, which is to open Plaid Link SDK using the public token you requested from Ratio above.

Once you open the Plaid Link SDK, monitor for onSuccess and onExit events.

If onSuccess - the user has successfully linked their bank account and you proceed with adding the bank account to the user account

If onExit - the user did not successfully authenticate their account (closed the Plaid SDK, bank connect was down, etc.) and you should bring them back to the screen that you are launching Plaid from

Reconnecting Accounts

Bank account connections can be disconnected from time to time, possibly at the request of the user or the financial institution. If a user wishes to perform a transaction, but the bank link has been disconnected, you will receive a bankLinkstatus = "LOGIN_REQUIRED" . To repair this, request an update token and go through the Plaid flow again.