LinkSuccessHandler typedef

LinkSuccessHandler = void Function(String publicToken, LinkSuccessMetadata metadata)

Called on a successfull account link.

Two arguments are returned.

  • publicToken The public token for the linked item. It is a string.
  • metadata The additional data related to the link session and account. It is an SuccessMetadata object.

The metadata object provides the following information:

link_session_id A unique identifier associated with a user's actions and events through the Link flow. Include this identifier when opening a support ticket for faster turnaround. institution An object with two properties:

  • name: The full institution name, such as 'Bank of America'
  • institution_id: The institution ID, such as ins_100000 accounts A list of objects with the following properties:
  • id: the id of the selected account
  • name: the name of the selected account
  • mask: the last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, it may also not match the mask that the bank displays to the user. This field is nullable.
  • type: the account type
  • subtype: the account subtype

For more information: https://plaid.com/docs/#onsuccess-callback

Implementation

typedef void LinkSuccessHandler(
    String publicToken, LinkSuccessMetadata metadata);