Balances
Show balance information and allow your connected accounts to perform payouts.
Balances renders the balance summary for the connected account, and information about any upcoming payouts. If you enable the balances component, connected accounts can also perform instant or manual payouts, or edit their payout schedule and external bank accounts. If Stripe is liable for a connected account’s negative balances, connected accounts can also proactively add money to their balance to avoid a negative balance and prevent business disruptions.
Note
This component renders a subset of the UI included in the payouts component.
When creating an Account Session, enable balances by specifying balances in the components parameter. You can enable or disable individual features of the balances component by specifying the features parameter under balances:
Command Line
Select a language
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
After creating the account session and initialising ConnectJS, you can render the balances component in the front end:
balances.js
Select a language
JavaScript
React
No results
// Include this element in your HTML
const balances = stripeConnectInstance.create('balances');
container.appendChild(balances);
In addition to the instant_payouts feature, enabling Instant Payouts might require additional steps:
- If your platform collects fees for a connected account, you must set up Instant Payout monetisation in the Dashboard .
- If your platform is liable for a connected account’s negative balances, your platform and connected account must be in a supported country for Instant Payouts and the accounts must meet the eligibility criteria .
- If Stripe is liable for a connected account’s negative balances, Stripe controls eligibility for the account.
Note
To use standard manual payouts, the connected account needs to have their payout schedule set to manual. You can enable payout schedule editing in the payouts component by setting the edit_payout_schedule feature to true.
