Skip to Content
@get-asset/reactComponentsAccounts Card

Accounts Connect

Connect a new institution. The default panel's Plaid card opens Plaid Link; after a successful connection it shows a confirmation step where each account is assigned as business or personal (personal accounts also pick a contribution and distribution ledger). Confirming links the accounts via the Asset API. Only Plaid is shown by default; add more methods (Gusto, QuickBooks, Manual) via the methods prop — non-Plaid ones fire onSelectMethod for you to wire up.

Preview

Loading preview…

Required scopes

The access token used by AssetProvider must include these scopes for this primitive to fetch data successfully:

  • plaid:create
  • plaid:read
  • ledger:read

API reference

Root props

PropTypeDefaultDescription
onConnected(institutions, account) => void—Called after the accounts are linked on the Asset API.
onError(error) => void—Called if creating the link token or linking fails.
onClose() => void—Called when the panel's close (×) button is clicked.
onSelectMethod(method) => void—Called when a non-Plaid method card (gusto / quickbooks / manual) is clicked.
methodsConnectionMethod[]—Override the connection methods shown.
onExit / onEventPlaidLink callbacks—Forwarded to Plaid Link.
classNamestring—Forwarded to the panel element.

States

Connect (default)

Loading preview…

ConfirmShown after Plaid succeeds — assign business/personal.

Loading preview…

On this page