Balance Settings
Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.
Was this section helpful? Yes No
Update balance settings
POST / v1 / balance_settings
Retrieve balance settings
GET / v1 / balance_settings
The Balance Setting object
Attributes
- object string, value is "balance_settings" String representing the object’s type. Objects of the same type share the same value.
- payments object Settings that apply to the Payments Balance.
The Balance Setting object
{ "object": "balance_settings", "payments": { "debit_negative_balances": true, "payouts": { "automatic_transfer_rules_by_currency": { "usd": [ { "type": "transfer_all", "payout_method": "fa_1ABC" } ] }, "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 } }}
Update balance settings
POST / v1 / balance_settings
Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts
Parameters
- payments object Settings that apply to the Payments Balance.
Returns
Returns the updated balance settings object for the account that was authenticated in the request.
Response
{ "object": "balance_settings", "payments": { "debit_negative_balances": true, "payouts": { "automatic_transfer_rules_by_currency": { "usd": [ { "type": "transfer_all", "payout_method": "fa_1ABC" } ] }, "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 } }}