payment-batches · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: paymentBatches · React: <FinBazePaymentBatches />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`requestPayment`	on

Options#

Passed to instance.create("payment-batches", options) or as props.

Option	Type
`batchId`	`string`	Open this batch instead of the list.

Every component also takes appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`payment.requested`	`onPaymentRequested`
`payment_batch.selected`	`onPaymentBatchSelected`

Use it#

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

<FinBazePaymentBatches />

const component = instance.create("payment-batches");
component.mount("#finbaze");