@get-asset/react
Accounts List
Styled table of a business's connected accounts, grouped into collapsible institution rows. Each account row shows its name and masked number, a status dot (synced time / Disconnected / Paused), how many statements are outstanding on it, and its net balance; institution rows roll up the group's status and balance. Opening a row leads into the statements being asked for and then a review of the transactions posted since the account last balanced. Each disconnected row's Reconnect action opens Plaid Link via the Asset API and refetches the list on success. To let users add new accounts, pair this with AssetAccountsConnect.
Built on the headless AccountsList compound from @get-asset/sdk.
Preview
Loading preview…
Required scopes
The access token used by AssetProvider must include these scopes for this primitive to fetch data successfully:
external_account:readrequest:readtransaction:readtransaction:deletedocument:readdocument:createplaid:create
API reference
Root props
| Prop | Type | Default | Description |
|---|---|---|---|
onConnected | (institutions, account) => void | — | Called after a successful Plaid connection (new account or reconnect). The list refetches automatically; use this for side effects (toasts, analytics). |
onError | (error) => void | — | Called if creating the link token or finalising the connection fails. |
onReconnect | (account) => void | — | Override the built-in Plaid reconnect with your own flow. When set, the Reconnect button calls this instead. |
institutionName | (account) => string | null | — | Override how accounts are grouped into institutions. Defaults to the account's institution_name (falling back to metadata_). |
source / type / status | ExternalAccount* filters | — | Filter the fetched accounts. Passed to the API. |
accounts | ExternalAccountPublic[] | — | Override fetched data. Skips the API call. |
state | "loading" | "error" | "empty" | — | Force a specific state for testing. |
tasks / documents / transactions | override arrays | — | Override the fetched statement requests, statement documents and review transactions. Skips those API calls. |
defaultScreen / defaultAccountId / onScreenChange / reviewState | see AccountsList | — | Open straight onto a screen, mirror screen changes in your own chrome, and force the review's state for testing. |
onTransactionRemove / onTransactionUpdate | review callbacks | — | Called after a transaction is deleted, and when one is corrected. Corrections to amount / date / description have no endpoint behind them, so persist them from this callback. |
className | string | — | Forwarded to the table's wrapper element. |
States
Loading preview…
Loading preview…
Loading preview…
Loading preview…