Capital promotion componentPublic preview

Show promotional content about a connected account's Capital financing offer and launch a Capital application.

The Capital promotion component allows your eligible connected accounts to complete a financing application in your platform’s website or application. Connected accounts can select their offer amount and terms, view contractual details, and submit their application. This component displays educational and promotional content about the Capital program as the starting point in the application process.

Alternate components

For a smaller version of this component, see the Capital promo tile component
To exclude education and promotional information about the Capital program, see the Capital application component

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 application component.

Create an Account Session

In your create an Account Session request, specify capital_financing_promotion in the components parameter.

Render the component

Render the Capital promotion component in the front end:

Method	Type	Description	Default
`setOnApplicationSubmitted`	`() => void`	The connected account has successfully submitted their application for financing.
`setOnApplicationStepChange`	`({step: string}) => void`	The connected account has navigated through the application.
`setLayout`	`full \| banner`	Controls the layout of the component. `banner` mode greatly reduces the vertical size of the component, which is useful when stacking the component with other content on the page.	`full`
`setOnEligibleFinancingOfferLoaded`	`({productType: standard \| refill \| none}) => void`	The connected account’s financing offer has been loaded. The `productType` field corresponds to the `product_type` field on the Financing Offer object.
`setPrivacyPolicyUrl`	`string`	Absolute URL of a page containing your privacy policy.	`https://stripe.com/privacy`
`setHowCapitalWorksUrl`	`string`	Absolute URL of a page with information about the Capital program.	`https://docs.stripe.com/capital/how-capital-for-platforms-works`
`setEligibilityCriteriaUrl`	`string`	Absolute URL of a page with information about eligibility criteria for the Capital program.	`https://docs.stripe.com/capital/how-capital-for-platforms-works`

Set the display state

Add the promotion component on your platform’s home page, or a dedicated Financing page in your platform’s website or app. The application component displays content dynamically based on the connected account’s financing status:

No active financing: If the connected account doesn’t have active financing, the component displays generic information about eligibility and the lending program.
With active offer: If the connected account is eligible for an offer, the component shows full offer details with a Start application button.
Offer in review: After an eligible connected account accepts and applies for a financing offer, use this state to display an application status tracker. Listen to the onApplicationStepChange event to track their offer’s progress. This event is emitted when the connected account advances to the next step or navigates back to a previous step or page in the Capital application process. The name of the next step is provided to the handler you provide in the step field. These steps can appear in any order and repeat. You can modify, add, and remove the step names at any time.
Only use the onApplicationStepChange object for analytics purposes, such as tracking the average page completion time or pages with the most drop off. Don’t use the onApplicationStepChange object to trigger operational or support workflows, such as sending emails to connected accounts who stopped application progress at a specific page.
Submitted offer: After a connected account submits their financing application, the component renders an empty screen. Listen to the onApplicationSubmitted event to display a confirmation screen instead.
Active financing in progress: The component doesn’t render (returns null).

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.

OptionalAdditional embedded components

The promotion component is one of several embedded components available for Capital for platforms. For example, you can embed the Capital financing component, which allows your connected accounts to manage their payments and view transaction history.