FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: bankConnections · React: <FinBazeBankConnections />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { bankConnections: { enabled: true } }
  }) { clientSecret }
}

Requirements#

The company must have these features effective: lunchflow_accounts. A hidden feature makes createEmbedSession fail with FEATURE_DISABLED.

Component features#

Switch these off per session with components.bankConnections.features.

FeatureDefault
connecton
disconnecton

Options#

Only the common options: appearance and navigation ("internal" or "external").

Events#

EventReact prop
readyonReady
navigateonNavigate
erroronError
bank_connection.connectedonBankConnectionConnected
bank_connection.disconnectedonBankConnectionDisconnected

Use it#

import { FinBazeBankConnections } from "@finbaze/embed-react";

<FinBazeBankConnections />
const component = instance.create("bank-connections");
component.mount("#finbaze");