Argyle Link Flutter SDK

Argyle Link Flutter SDK provides a way to integrate Argyle Link into your Flutter app.

Note: We recommend you to lock your app to portrait orientation.

Requirements for iOS:

  • Xcode 14.0+
  • iOS 14.0+

Requirements for Android:

Set the minSdkVersion in android/app/build.gradle:

android {
    defaultConfig {
        minSdkVersion 26 // or greater

1. Add the SDK dependency

Add argyle_link_flutter as a dependency in your pubspec.yaml file.

  1. Log into your Console instance
  2. Navigate to the API Keys area under the Developer menu
  3. Copy your Sandbox or Production Link API Key for use in the next steps

2. Utilize user tokens

To prevent your API key and secret from being exposed on the front-end, request user tokens on your server side.

import 'package:argyle_link_flutter/link_config.dart';
// (Optional) Callback argument type definitions
import 'package:argyle_link_flutter/account_data.dart';
import 'package:argyle_link_flutter/argyle_link.dart';
import 'package:argyle_link_flutter/form_data.dart';

// ...

final config = LinkConfig(
  userToken: 'USER_TOKEN',
  sandbox: true, // Set it to false for production environment.
  // (Optional) Add a Link flow customization created in Console:
  //    flowId: '<ID of the Link flow>',
  // (Optional) Add a deposit switch flow:
  //    ddsConfig: '<Encrypted target deposit destination value>',
  // (Optional) Limit Link search to specific Items:
  //    items: ['item_000001422', 'item_000025742'],
  // (Optional) Connect directly to an existing account:
  //    accountId: '<ID of the account>',
  // (Optional) Callback examples:
  onAccountConnected: (payload) => debugPrint('onAccountConnected'),
  onAccountError: (payload) => debugPrint('onAccountError'),
  onDDSSuccess: (payload) => debugPrint('onDDSSuccess'),
  onDDSError: (payload) => debugPrint('onDDSError'),
  onTokenExpired: (updateToken) => {
    // Generate a new user token.
    // updateToken(newToken)

// ArgyleLink.close()   // Manually close Link (typically the user closes Link).


For detailed guidance on how to integrate our SDK please review the example app, and also check out our Link SDK Documentation.