| [ Web Proxy ] |
| Viewing: https://docs.stripe.com/api/balance-settings | [Back] [Original] |
Options for customizing account balances and payout settings for a Stripe platforms connected accounts.
String representing the objects type. Objects of the same type share the same value.
Settings that apply to the Payments Balance.
{ "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 } }}Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts
Settings that apply to the Payments Balance.
Returns the updated balance settings object for the account that was authenticated in the request.
curl https://api.stripe.com/v1/balance_settings \ -u "sk_test_wU7nrJCZspk1NPDxiQgAF05qsk_test_wU7nrJCZspk1NPDxiQgAF05q:" \ -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \ -d "payments[payouts][schedule][interval]=monthly" \ -d "payments[payouts][schedule][monthly_payout_days][]=5" \ -d "payments[payouts][schedule][monthly_payout_days][]=20"{ "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 } }}| Web Proxy Viewer | New URL | Original Page |