Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.
This API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect. If you are not in this preview, please use the Accounts v1 API to manage your connected accounts’ balance settings instead.
Attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- debit_
negative_ balancesnullable boolean A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See Understanding Connect account balances for details. The default value is
false
when controller.requirement_collection isapplication
, which includes Custom accounts, otherwisetrue
. - payoutsnullable object
Settings specific to the account’s payouts.
- settlement_
timingobject Settings related to the account’s balance settlement timing. See Balances and settlement time to learn more.
{ "object": "balance_settings", "debit_negative_balances": true, "payouts": { "schedule": { "interval": "daily" }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days": 2 }}
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.
- settlement_
timingobject Settings related to the account’s balance settlement timing.
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_payout_days": [ 5, 20 ] }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days": 2 }}
Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts
Parameters
No parameters.
Returns
Returns a balance settings object for the account specified in the request.
{ "object": "balance_settings", "debit_negative_balances": true, "payouts": { "schedule": { "interval": "daily" }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days": 2 }}
External bank accounts are financial accounts associated with a Stripe platform’s connected accounts for the purpose of transferring funds to or from the connected account’s Stripe balance.
This API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect. If you are not in this preview, please use the Accounts v1 API to manage your connected accounts’ external bank accounts instead.