Capital application componentPublic preview
Show an end-to-end application flow for Capital financing.
The Capital application component allows your eligible connected accounts to complete a financing application in your platform’s website or application. They can select their offer amount and terms, view contractual details, and submit their application.
This component is similar to the Capital promotion component, but it invokes the application directly and excludes educational or promotional content. Use this embedded component if you want to customize how to display the financing offer and program information to eligible connected accounts.
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:
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_
in the components
parameter.
Render the application component
Render the Capital application component in the front end:
Set the display state
Add the application component on a page your connected accounts use to view payments and payouts reporting information, or a dedicated Financing page in your platform’s UI. Make sure to use a different location than the Connect promotion component (if applicable).
To determine if a connected account is eligible for an offer, call the List financing offers endpoint and pass the connected account ID in the connected_
parameter.
The application component displays content dynamically based on the connected account’s financing status:
No active financing: If an account doesn’t have an eligible financing offer, then the application component doesn’t render (returns null).
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 theonApplicationStepChange
object to trigger operational or support workflows, such as sending emails to connected accounts who stopped application progress at a specific page.Submitted offer: If a connected account has already submitted their financing application, the Capital financing application 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.