Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts
Parameters
- paymentsobjectRequired
Settings that apply to the Payments Balance.
- payments.
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.
- payments.
payoutsobject Settings specific to the account’s payouts.
- payments.
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.
- payments.
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
- payments.
payouts. schedule. monthly_ payout_ daysarray of integers The days of the month when available funds are paid out, specified as an array of numbers 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. - payments.
payouts. schedule. weekly_ payout_ daysarray of enums The days of the week when available funds are paid out, specified as an array, e.g., [
monday,tuesday]. Required and applicable only ifintervalisweekly.Possible enum valuesfridaySelect Friday as one of the weekly payout day
mondaySelect Monday as one of the weekly payout day
thursdaySelect Thursday as one of the weekly payout day
tuesdaySelect Tuesday as one of the weekly payout day
wednesdaySelect Wednesday as one of the weekly payout day
- payments.
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.
- payments.
settlement_ timingobject Settings related to the account’s balance settlement timing.
- payments.
settlement_timing. delay_ days_ overrideinteger The number of days charge funds are held before becoming available. The default value is
minimum, representing the lowest available value for the account. The maximum value is 31. Thedelay_parameter remains at the last configured value ifdays payouts.isschedule. interval manual. Learn more about controlling delay days.
Returns
Returns the updated balance settings object for the account that was authenticated in the request.
{ "object": "balance_settings", "payments": { "debit_negative_balances": true, "payouts": { "schedule": { "interval": "monthly", "monthly_payout_days": [ 5, 20 ] }, "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