Manage payout schedule

Manage the automatic payout schedule to your connected accounts.

Note

Use the Balance Settings API to manage payout settings for both Accounts v1 and Accounts v2. The Balance Settings object follows a similar structure and behavior to the settings.payouts hash in Accounts v1. If your Account v1 is currently using settings.payouts, you don’t need to migrate.

When using automatic payouts, the payments.payouts.schedule hash contains details on when a Stripe account’s funds are available and when the balance is automatically paid out:

{
  "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"],
        "monthly_payout_days": null
      },
      "statement_descriptor": null,
      "status": "enabled"
    },
    "settlement_timing": {
      "delay_days_override": 3,
      "delay_days": 3
    }
  }
}

delay_days property

The settlement_timing.delay_days property reflects how long it takes for on_behalf_of charges (or direct charges performed on the connected account) to become available for payout. You can edit this property on accounts where you own fraud and dispute liability. This property can be overridden by setting delay_days_override to a number up to 31. Passing an empty string to delay_days_override will return delay_days to the default, which is the lowest available value for the account.

This field is useful for dictating automatic payouts. Stripe calculates the delay in business days or calendar days, depending on the connected accounts’ country. For example, if you want a connected account based in Singapore (which uses calendar day delays) to receive their funds two weeks after the charge is made, set interval to daily and delay_days_override to 14.

For accounts where Stripe manages fraud and dispute liability (for example, Standard accounts), the default is the lowest permitted value for the account, determined by the connected account’s country. For accounts where you own fraud and dispute liability, the value remains at your original payout speed by default.

Interval property

Platforms that manage fraud and dispute liability, or have platform controls, can adjust the payout interval. There are four possible settings for the interval property:

manual: This setting prevents automatic payouts. You will have to manually pay out the account’s balance using the Payouts API (acting as the connected account). You also set an account to manual to use Instant Payouts.
daily: This setting automatically pays out charges delay_days days after they’re created. The delay_days value can’t be less than your own payout schedule or less than the default payout schedule for the account.
weekly: This setting automatically pays out the balance at least once a week, with the day(s) specified by the weekly_payout_days parameter (an array of days of the week).
monthly: This setting automatically pays out the balance at least once a month, as specified by the monthly_payout_days parameter (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.