bank-rules · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: bankRules · React: <FinBazeBankRules />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`create`	on
`edit`	on
`delete`	on
`apply`	on

Options#

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`bank_rule.created`	`onBankRuleCreated`
`bank_rule.updated`	`onBankRuleUpdated`
`bank_rule.deleted`	`onBankRuleDeleted`

Use it#

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

<FinBazeBankRules />

const component = instance.create("bank-rules");
component.mount("#finbaze");