Maintaining a public-key based integration

1const handler = Plaid.create({
2  clientName: 'Plaid Quickstart',
3  env: 'sandbox',
4  key: 'PUBLIC_KEY',
5  product: ['transactions'],
6  onSuccess: (public_token, metadata) => {},
7  onLoad: () => {},
8  onExit: (err, metadata) => {},
9  onEvent: (eventName, metadata) => {},
10  countryCodes: ['US'],
11  webhook: 'https://requestb.in',
12  linkCustomizationName: '',
13  language: 'en',
14  oauthNonce: null,
15  oauthRedirectUri: null,
16  oauthStateId: null,
17  token: null,
18  paymentToken: null,
19});

1const handler = Plaid.create({
2  ...,
3  onSuccess: (public_token, metadata) => {
4    fetch('//yourserver.com/exchange_public_token', {
5      method: 'POST',
6      body: {
7        public_token: public_token,
8        accounts: metadata.accounts,
9        institution: metadata.institution,
10        link_session_id: metadata.link_session_id,
11      },
12    });
13  }
14});

1{
2  institution: {
3    name: 'Wells Fargo',
4    institution_id: 'ins_4'
5  },
6  accounts: [
7    {
8      id: 'ygPnJweommTWNr9doD6ZfGR6GGVQy7fyREmWy',
9      name: 'Plaid Checking',
10      mask: '0000',
11      type: 'depository',
12      subtype: 'checking',
13      verification_status: ''
14    },
15    {
16      id: '9ebEyJAl33FRrZNLBG8ECxD9xxpwWnuRNZ1V4',
17      name: 'Plaid Saving',
18      mask: '1111',
19      type: 'depository',
20      subtype: 'savings'
21    }
22    ...
23  ],
24  link_session_id: '79e772be-547d-4c9c-8b76-4ac4ed4c441a'
25}

1const handler = Plaid.create({
2  ...,
3  onExit: (error, metadata) => {
4    // Save data from the onExit handler
5    supportHandler.report({
6      error: error,
7      institution: metadata.institution,
8      link_session_id: metadata.link_session_id,
9      plaid_request_id: metadata.request_id,
10      status: metadata.status,
11    });
12  },
13});

1{
2  error_type: 'ITEM_ERROR',
3  error_code: 'INVALID_CREDENTIALS',
4  error_message: 'the credentials were not correct',
5  display_message: 'The credentials were not correct.',
6}

1{
2  institution: {
3    name: 'Wells Fargo',
4    institution_id: 'ins_4'
5  },
6  status: 'requires_credentials',
7  link_session_id: '36e201e0-2280-46f0-a6ee-6d417b450438',
8  request_id: '8C7jNbDScC24THu'
9}

1const handler = Plaid.create({
2  ...,
3  onEvent: (eventName, metadata) => {
4    // send event and metadata to self-hosted analytics
5    analytics.send(eventName, metadata);
6  },
7});

1{
2  error_type: 'ITEM_ERROR',
3  error_code: 'INVALID_CREDENTIALS',
4  error_message: 'the credentials were not correct',
5  exit_status: null,
6  institution_id: 'ins_4',
7  institution_name: 'Wells Fargo',
8  institution_search_query: 'wellsf',
9  mfa_type: null,
10  view_name: 'ERROR'
11  request_id: 'm8MDnv9okwxFNBV',
12  link_session_id: '30571e9b-d6c6-42ee-a7cf-c34768a8f62d',
13  timestamp: '2017-09-14T14:42:19.350Z',
14}

1const handler = Plaid.create({ ... });
2
3// Graceful exit - Link may display a confirmation screen
4// depending on how far the user is in the flow
5handler.exit();

1const handler = Plaid.create({ ... });
2
3// Force exit - Link exits immediately
4handler.exit({ force: true });

1let linkConfiguration = PLKConfiguration(
2  env: .sandbox,
3  key: "<YOUR_PLAID_PUBLIC_KEY>",
4  product: [.auth]
5)
6linkConfiguration.clientName = "My application";
7linkConfiguration.language = "en";
8linkConfiguration.countryCodes = ["US", "CA", "GB"];
9linkConfiguration.webhook = "https://webhook.com";
10linkConfiguration.linkCustomizationName = "default";
11linkConfiguration.oauthRedirectUri = "<YOUR_OAUTH_REDIRECT_URI>"
12linkConfiguration.oauthNonce = UUID().uuidString
13
14let linkViewController = PLKPlaidLinkViewController(
15  configuration: linkConfiguration,
16  delegate: self
17)
18
19present(linkViewController, animated: true)

1func linkViewController(
2  _ linkViewController: PLKPlaidLinkViewController,
3  didSucceedWithPublicToken publicToken: String,
4  metadata: [String : Any]?
5) {
6  dismiss(animated: true) {
7  // Exchange publicToken with an accessToken on your server
8    NSLog("Successfully linked account!\npublicToken: (publicToken)\nmetadata: (metadata ?? [:])")
9  }
10}

1{
2  kPLKMetadataInstitutionKey: @{
3    kPLKMetadataInstitutionNameKey: 'Wells Fargo',
4    kPLKMetadataInstitutionIdKey: 'ins_4'
5  },
6  kPLKMetadataAccountsKey: [
7    @{
8      kPLKMetadataIdKey: 'ygPnJweommTWNr9doD6ZfGR6GGVQy7fyREmWy',
9      kPLKMetadataNameKey: 'Plaid Checking',
10      kPLKMetadataMaskKey: '0000',
11      kPLKMetadataTypeKey: 'depository',
12      kPLKMetadataSubtypeKey: 'checking',
13      kPLKMetadataAccountVerificationStatusKey: ''
14    },
15    @{
16      kPLKMetadataIdKey: '9ebEyJAl33FRrZNLBG8ECxD9xxpwWnuRNZ1V4',
17      kPLKMetadataNameKey: 'Plaid Saving',
18      kPLKMetadataMaskKey: '1111',
19      kPLKMetadataTypeKey: 'depository',
20      kPLKMetadataSubtypeKey: 'savings'
21    }
22    ...
23  ],
24  kPLKMetadataLinkSessionIdKey: '79e772be-547d-4c9c-8b76-4ac4ed4c441a'
25}

1func linkViewController(
2    _ linkViewController: PLKPlaidLinkViewController,
3  didExitWithError error: Error?,
4                metadata: [String : Any]?
5) {
6  dismiss(animated: true) {
7    if let error = error {
8      NSLog("Failed to link account due to: (error.localizedDescription)\n metadata: (metadata ?? [:])")
9      self.handleError(error, metadata: metadata)
10    }
11    else {
12      NSLog("Plaid link exited with metadata: (metadata ?? [:])")
13      self.handleExitWithMetadata(metadata)
14    }
15  }
16}

1{
2  kPLKErrorTypeKey: 'ITEM_ERROR',
3  kPLKErrorCodeKey: 'INVALID_CREDENTIALS',
4  kPLKErrorMessageKey: 'the credentials were not correct',
5  kPLKDisplayMessageKey: 'The credentials were not correct.',
6}

1{
2   kPLKMetadataInstitutionKey: @{
3    kPLKMetadataInstitutionNameKey: 'Wells Fargo',
4    kPLKMetadataInstitutionIdKey: 'ins_4'
5  },
6  kPLKMetadataLinkSessionIdKey: '36e201e0-2280-46f0-a6ee-6d417b450438',
7  kPLKMetadataRequestIdKey: '8C7jNbDScC24THu'
8}

1func linkViewController(
2  _ linkViewController: PLKPlaidLinkViewController,
3  didHandleEvent event: String,
4  metadata: [String : Any]?
5) {
6  NSLog("Link event: (event)\nmetadata: (metadata ?? [:])")
7}

1{
2  kPLKMetadataErrorTypeKey: 'ITEM_ERROR',
3  kPLKMetadataErrorCodeKey: 'INVALID_CREDENTIALS',
4  kPLKMetadataErrorMessageKey: 'the credentials were not correct',
5  kPLKMetadataExitStatusKey: '',
6  kPLKMetadataInstitutionIdKey: 'ins_4',
7  kPLKMetadataInstitutionNameKey: 'Wells Fargo',
8  kPLKMetadataInstitutionSearchQueryKey: 'wellsf',
9  kPLKMetadataLinkSessionIdKey: '30571e9b-d6c6-42ee-a7cf-c34768a8f62d',
10  kPLKMetadataMFATypeKey: '',
11  kPLKMetadataRequestIdKey: 'm8MDnv9okwxFNBV',
12  kPLKMetadataTimestampKey: '2017-09-14T14:42:19.350Z',
13  kPLKMetadataViewNameKey: 'ERROR'
14}

1import android.content.Intent
2import com.plaid.link.Plaid
3import com.plaid.linkbase.models.LinkConfiguration
4import com.plaid.linkbase.models.PlaidEnvironment
5import com.plaid.linkbase.models.PlaidProduct
6import com.plaid.link.configuration.LinkLogLevel
7
8class MainActivity : AppCompatActivity() {
9
10  override fun onCreate(savedInstanceState: Bundle?) {
11    super.onCreate(savedInstanceState)
12
13    // Open Link – this will usually be in a click listener
14    this@MainActivity.openPlaidLink(
15      linkConfiguration = linkConfiguration {
16        environment = PlaidEnvironment.SANDBOX
17        products = listOf(PlaidProduct.TRANSACTIONS)
18        clientName = "My Application name"
19        language = Locale.ENGLISH.language
20        countryCodes = listOf(Locale.US.country)
21        webhook = "https://requestb.in"
22        linkCustomizationName = "default"
23        publicToken = null
24        paymentToken = null
25      }
26    )
27  }
28}