Capital financing componentPublic preview

Allow a connected account to view and manage their active Capital financing.

The Capital financing embedded component allows connected accounts to view and manage their financing status after they accept an offer. Connected accounts can:

View their payment progress
Monitor transaction history
Make payments, if applicable to their type of financing

Before you begin

Embedded components are only available to display to connected accounts in the US and UK.
Before you go live, you must enable automatic offers and submit your integration to Stripe for review.
When you render the component, it links out to Stripe content by default. You can replace the link for Privacy policy and How Capital for platforms works with your equivalent documentation.

Install Capital embedded components

Install a beta version of the Stripe SDKs to create account sessions for private preview components:

Ruby >=15.5.0-beta.1
Python >=12.5.0b1
PHP >=17.6.0-beta.1
Node >=18.5.0-beta.1
.NET >=48.5.0-beta.1
Java >=29.5.0-beta.1
Go >=82.5.0-beta.1

Use the beta version of the Stripe’s client-side libraries to render private preview components:

Install the library:

npm install --save @stripe/connect-js@preview

If you’re using React in your application:

npm install --save @stripe/react-connect-js@preview

Set up Connect.js

If you don’t already use Stripe embedded components in your application, initialize Connect.js before you integrate the financing component.

Create an Account Session

In your create an Account Session request, specify capital_financing in the components parameter to enable the financing component.

Render the component

Render the Capital financing component in the front end:

Method	Type	Description	Default
`setDefaultFinancingOffer`	`string`	Financing Offer ID to render on initial load of the component. If omitted, the component displays the active or most recent financing.
`setShowFinancingSelector`	`boolean`	If true, render the financing dropdown selector to allow the connected account to change the displayed financing.	`true`
`setOnFinancingsLoaded`	`({total: number}) => void`	The component loaded the connected account’s financing history.
`setSupportUrl`	`string`	Absolute URL of your support site.	`https://support.stripe.com/`
`setHowCapitalWorksUrl`	`string`	Absolute URL of a page with information about the Capital program.	`https://docs.stripe.com/capital/how-stripe-capital-works`

Set the display state

Place the financing component on a page your connected accounts currently use to view payments and payouts reporting information, or a dedicated Financing page.

The financing component displays content dynamically based on the connected account’s financing status:

No financing history: If a connected account has an offer, but hasn’t accepted or applied for it yet, the financing component displays nothing. Listen to the onFinancingsLoaded event to display a custom message in the financing component for this state or hide the financing component until financing data becomes available.
Offer in review: After an eligible connected account accepts and applies for a financing offer, use this state to render the component to display an application status tracker while they wait for offer approval.

Submit the component for review

To use any of the Capital components in live mode, Stripe and our financial partners must review and approve all customer-facing content that references Stripe Capital:

Create a test offer in a sandbox, and set the offer status to delivered. Use this test offer to preview the application component in your platform’s website or dashboard.
Capture a preview of the sandbox offer and how the embedded component displays in your platform’s UI (such as screenshots or a recorded video).
Submit the preview to Stripe. After approval, Stripe enables you to use the component in live mode.