Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
Overview
Get started with Connect
Integration fundamentals
Example integrations
Account management
Onboard accounts
Configure account Dashboards
    Get started with Connect embedded components
    Customize Connect embedded components
    Supported Connect embedded components
      Onboarding and compliance
      Account management
      Account onboarding
      Notification banner
      Payment management
      Payments
      Payment details
      Disputes for a payment
      Disputes list
      Payment method settings
      Payout management
      Payouts
      Payouts list
      Balances
      Capital
      Capital financing
      Capital financing application
      Capital financing promotion
      Tax
      Tax registrations
      Tax settings
      Export tax transactions
      Treasury and issuing
      Financial account
      Financial account transactions
      Issuing card
      Issuing cards list
      Reporting
      Documents
      Reporting chart
      Apps
      App install
      App viewport
    Stripe Dashboard customization
    Platform controls for Stripe Dashboard accounts
    Express Dashboard
Work with connected account types
Payment processing
Accept payments
Pay out to accounts
Platform administration
Manage your Connect platform
Tax forms for your Connect platform
HomePlatforms and marketplacesConfigure account DashboardsSupported Connect embedded components

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 is part of 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
cURL
curl https://api.stripe.com/v1/account_sessions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d account=
{{CONNECTED_ACCOUNT_ID}}
\ -d "components[balances][enabled]"=true \ -d "components[balances][features][instant_payouts]"=true \ -d "components[balances][features][standard_payouts]"=true \ -d "components[balances][features][edit_payout_schedule]"=true \ -d "components[balances][features][external_account_collection]"=true

After creating the account session and initializing ConnectJS, you can render the balances component in the front end:

balances.js
JavaScript
// Include this element in your HTML const balances = stripeConnectInstance.create('balances'); container.appendChild(balances);

Enabling Instant Payouts might require additional steps:

  • If your platform collects fees for a connected account, you must set up Instant Payout monetization in the Dashboard.
  • If your platform is liable for a connected account’s negative balances, your platform must be in a supported country and the account must be in the same country as the platform and must be in the local currency.
  • 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.

Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc