Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.
Attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- paymentsobject
Settings that apply to the Payments Balance.
{ "object": "balance_settings", "payments": { "debit_negative_balances": true, "payouts": { "minimum_balance_by_currency": { "usd": 1500, "cad": 8000 }, "schedule": { "interval": "weekly", "weekly_payout_days": [ "monday", "wednesday" ] }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days_override": 3, "delay_days": 3 } }}Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts
Parameters
- paymentsobject
Settings that apply to the Payments Balance.
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": { "minimum_balance_by_currency": { "usd": 1500, "cad": 8000 }, "schedule": { "interval": "monthly", "monthly_payout_days": [ 5, 20 ] }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days_override": 3, "delay_days": 3 } }}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", "payments": { "debit_negative_balances": true, "payouts": { "minimum_balance_by_currency": { "usd": 1500, "cad": 8000 }, "schedule": { "interval": "weekly", "weekly_payout_days": [ "monday", "wednesday" ] }, "statement_descriptor": null, "status": "enabled" }, "settlement_timing": { "delay_days_override": 3, "delay_days": 3 } }}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.