Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

The Balance Setting object 

Connect
Balance Settings
The Balance Setting object

Attributes

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • paymentsdictionary

    Settings that apply to the Payments Balance.

    • payments.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 is application, which includes Custom accounts, otherwise true.

    • payments.payoutsnullable dictionary

      Settings specific to the account’s payouts.

      • payments.payouts.minimum_balance_by_currencynullable dictionary

        The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the minimum balances for automatic payouts.

      • payments.payouts.schedulenullable dictionary

        Details on when funds from charges are available, and when they are paid out to an external account. See our Setting Bank and Debit Card Payouts documentation for details.

        • payments.payouts.schedule.intervalnullable enum

          How frequently funds will be paid out. One of manual (payouts only created via API call), daily, weekly, or monthly.

          Possible enum values
          daily

          Stripe automatically sends money to your bank account daily

          manual

          You manually send funds to your bank account

          monthly

          Stripe automatically sends money to your bank account monthly

          weekly

          Stripe automatically sends money to your bank account weekly

        • payments.payouts.schedule.monthly_payout_daysnullable array of integers

          The day of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.

        • payments.payouts.schedule.weekly_payout_daysnullable array of enums

          The days of the week when available funds are paid out, specified as an array, for example, [monday, tuesday]. Only shown if interval is weekly.

          Possible enum values
          friday

          Select Friday as one of the weekly payout day

          monday

          Select Monday as one of the weekly payout day

          thursday

          Select Thursday as one of the weekly payout day

          tuesday

          Select Tuesday as one of the weekly payout day

          wednesday

          Select Wednesday as one of the weekly payout day

      • payments.payouts.statement_descriptornullable string

        The text that appears on the bank account statement for payouts. If not set, this defaults to the platform’s bank descriptor as set in the Dashboard.

      • payments.payouts.statusenum

        Whether the funds in this account can be paid out.

        Possible enum values
        disabled

        Funds in this account cannot be paid out.

        enabled

        Funds in this account can be paid out.

    • payments.settlement_timingdictionary

      Settings related to the account’s balance settlement timing. See Balances and settlement time to learn more.

      • payments.settlement_timing.delay_daysinteger

        The number of days charge funds are held before becoming available.

      • payments.settlement_timing.delay_days_overridenullable integer

        The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account.

The Balance Setting object
{
  "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
    }
  }
}