Payouts
Show payout information and allow your users to perform payouts.
Payouts renders the balance summary, the payout schedule, and a list of payouts for the connected account. A connected account user can also use it to perform instant or manual payouts.
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:
curl https://api.stripe.com/v1/account_sessions \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \ -d "account=" \ -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"{{CONNECTED_ACCOUNT_ID}}
After creating the account session and initializing ConnectJS, you can render the payouts component in the front end:
In addition to the instant_ feature, 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 and connected account must 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_ feature to true.