2.x to 3.x Migration Guide

Plaid released the Android 3.0.0 SDK on September 20th, 2020. Upgrading to the new 3.x SDK allows you to take advantage of a unified mobile API and support all new features. This article provides a guide on how to upgrade a Plaid integration from the Android 2.x SDK to the 3.x SDK.

Plaid.initialize(this)

Is no longer part of the API and can be removed.

val linkTokenConfiguration = linkTokenConfiguration {
  token = "LINK_TOKEN_FROM_SERVER"
  logLevel = if (BuildConfig.DEBUG) LinkLogLevel.VERBOSE else LinkLogLevel.ERROR
}

Create a PlaidHandler - A PlaidHandler is a one-time use object used to open a Link session. It should be created as early as possible, since it must be completed before Link opens, and if delayed until just before Link opening it can have a perceptible impact on Link startup time.

val plaidHandler: PlaidHandler = Plaid.create(application, linkTokenConfiguration)

We've removed the openLink functions on the Plaid object as well as the Kotlin extension functions for Activity and Fragment.

Plaid.openLink(activity, configuration)

this@MyActivity.openPlaidLink(configuration)

this@MyFragment.openPlaidLink(configuration)

Instead you will need to call open on the PlaidHandler you created, passing in an Activity or Fragment.

plaidHandler.open(activity)

com.plaid.link.result.PlaidLinkResultHandler has been renamed to com.plaid.link.result.LinkResultHandler

LinkSuccessMetadata.rawMetadata renamed to LinkSuccessMetadata.metadata

Fields renamed

• accountId -> id
• accountName -> name
• accountNumber -> mask
• accountSubtype -> subtype also type changed from String to com.plaid.link.result.LinkAccountSubtype
• accountType has been removed, it is now a com.plaid.link.result.LinkAccountType object within LinkAccountSubtype

private val linkResultHandler = LinkResultHandler(
  // ...
  onSuccess = { it: LinkSuccess ->
    // Send public_token to your server, exchange for access_token
    val publicToken = it.publicToken
    val metadata = it.metadata
    metadata.accounts.forEach { account ->
      val accountId = account.id
      val accountName = account.name
      val accountMask = account.mask
      val accountSubType = account.subtype
    }
    val institutionId = metadata.institution?.id
    val institutionName = metadata.institution?.name
  }
)

• errorCode has been typed as an ErrorCode object
• errorType has been removed from LinkError and added to the ErrorCode object
• errorJson field has been added with raw JSON from server

• institutionId and institutionName moved into institution which is a LinkInstitution and renamed to id and name object
• exitStatus removed
• metadataJson field has been added with raw JSON from server

private val linkResultHandler = LinkResultHandler(
  // ...
  onExit = {
    val error = it.error
    error?.let { error ->
      val errorCode = error.errorCode
      val errorType = error.errorCode.errorType
      val errorMessage = error.errorMessage
      val displayMessage = error.displayMessage
    }
    val metadata = it.metadata
    val institutionId = metadata.institution?.id
    val institutionName = metadata.institution?.hame
    val linkSessionId = metadata.linkSessionId;
    val requestId = metadata.requestId;
  }
)

LinkEventMetadata metadataJson added with raw JSON from server

All exceptions moved from com.plaid.link.internal.exceptions to com.plaid.link.exceptions