Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts
Parameters
- debit_
negative_ balancesboolean A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see Understanding Connect Account Balances.
- payoutsobject
Settings specific to the account’s payouts.
- payouts.
scheduleobject Details on when funds from charges are available, and when they are paid out to an external account. For details, see our Setting Bank and Debit Card Payouts documentation.
- payouts.
schedule. intervalenum How frequently available funds are paid out. One of:
daily,manual,weekly, ormonthly. Default isdaily.Possible enum valuesdailyStripe automatically sends money to your bank account daily
manualYou manually send funds to your bank account
monthlyStripe automatically sends money to your bank account monthly
weeklyStripe automatically sends money to your bank account weekly
- payouts.
schedule. monthly_ anchorinteger The day of the month when available funds are paid out, specified as a number between 1–31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if
intervalismonthly. - payouts.
schedule. weekly_ anchorenum The day of the week when available funds are paid out (required and applicable only if
intervalisweekly.)Possible enum valuesfridayAvailable funds are paid out on Friday
mondayAvailable funds are paid out on Monday
thursdayAvailable funds are paid out on Thursday
tuesdayAvailable funds are paid out on Tuesday
wednesdayAvailable funds are paid out on Wednesday
- payouts.
statement_ descriptorstring The text that appears on the bank account statement for payouts. If not set, this defaults to the platform’s bank descriptor as set in the Dashboard.
- settlement_
timingobject Settings related to the account’s balance settlement timing.
- settlement_timing.
delay_ daysinteger The number of days charge funds are held before becoming available. May also be set to
minimum, representing the lowest available value for the account country. Default isminimum. Thedelay_parameter remains at the last configured value ifdays payouts.isschedule. interval manual. Learn more about controlling payout delay days.
Returns
Returns the updated balance settings object for the account that was authenticated in the request.
{ "object": "balance_settings", "debit_negative_balances": true, "payouts": { "schedule": { "interval": "monthly", "monthly_anchor": 5 }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days": 2 }}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc