1.x to 2.x Migration Guide

Reference for migrating the Link Android SDK from 1.x to 2.x

Android Link SDK versions prior to 3.5.0 (released August 2021) will no longer work with the Plaid API as of November 1, 2022. If you are using a version of the Android Link SDK earlier than 3.5.0, you must upgrade to version 3.5.0 or later before November 1, 2022.

Overview

The 2.x release is an overhaul of the SDK's API to simplify integration and align it with the iOS SDK.

  • The content provider is no longer necessary. Instead, call Plaid.initialize(application) to initialize the SDK
  • PlaidOptions has been removed, instead pass environment and logLevel in your LinkConfiguration
  • The PlaidLinkResultHandler no longer requires a request code
  • The onCancelled callback has been removed, all exit events will be returned in onExit
  • Adds support for Account Subtype filtering
  • Kotlin functions have been added for a more semantic API
  • Several object and field names have been adjusted

For an example demonstrating how to migrate from the 1.x to 2.x SDK, see a sample migration on GitHub.