Function useFinancialConnectionsSheet

useFinancialConnectionsSheet(): {
    collectBankAccountToken: (
        clientSecret: string,
        params?: CollectBankAccountTokenParams,
    ) => Promise<FinancialConnections.TokenResult>;
    collectFinancialConnectionsAccounts: (
        clientSecret: string,
        params?: CollectFinancialConnectionsAccountsParams,
    ) => Promise<SessionResult>;
    loading: boolean;
}
React hook for accessing functions on the Financial Connections sheet.

Retuns the collectBankAccountToken and collectFinancialConnectionsAccounts functions, and a loading boolean that you can use to display loading state (like showing a spinner).

Returns {
    collectBankAccountToken: (
        clientSecret: string,
        params?: CollectBankAccountTokenParams,
    ) => Promise<FinancialConnections.TokenResult>;
    collectFinancialConnectionsAccounts: (
        clientSecret: string,
        params?: CollectFinancialConnectionsAccountsParams,
    ) => Promise<SessionResult>;
    loading: boolean;
}
- Defined in src/hooks/useFinancialConnectionsSheet.tsx:12