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

Payouts

Show payout information and allow your users to perform payouts.

Copy page

Payouts renders the balance summary and a list of payouts for the connected account, including information about any upcoming payouts. If you enable the payouts 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.

When creating an Account Session, enable the payouts embedded component by specifying payouts in the components parameter. You can enable or disable individual features of the payouts component by specifying the features parameter under payouts:

Command Line
cURL
curl https://api.stripe.com/v1/account_sessions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d account=
{{CONNECTED_ACCOUNT_ID}}
\ -d "components[payouts][enabled]"=true \ -d "components[payouts][features][instant_payouts]"=true \ -d "components[payouts][features][standard_payouts]"=true \ -d "components[payouts][features][edit_payout_schedule]"=true \ -d "components[payouts][features][external_account_collection]"=true

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

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

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 programme.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc