mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-04 00:00:47 -04:00
97 lines
4.2 KiB
Ruby
97 lines
4.2 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
class BalanceSettingsService < StripeService
|
|
class RetrieveParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
|
|
def initialize(expand: nil)
|
|
@expand = expand
|
|
end
|
|
end
|
|
|
|
class UpdateParams < Stripe::RequestParams
|
|
class Payouts < Stripe::RequestParams
|
|
class Schedule < Stripe::RequestParams
|
|
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
|
|
attr_accessor :interval
|
|
# The days of the month when available funds are paid out, specified as 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. Required and applicable only if `interval` is `monthly`.
|
|
attr_accessor :monthly_payout_days
|
|
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. (required and applicable only if `interval` is `weekly`.)
|
|
attr_accessor :weekly_payout_days
|
|
|
|
def initialize(interval: nil, monthly_payout_days: nil, weekly_payout_days: nil)
|
|
@interval = interval
|
|
@monthly_payout_days = monthly_payout_days
|
|
@weekly_payout_days = weekly_payout_days
|
|
end
|
|
end
|
|
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
|
|
attr_accessor :schedule
|
|
# 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.
|
|
attr_accessor :statement_descriptor
|
|
|
|
def initialize(schedule: nil, statement_descriptor: nil)
|
|
@schedule = schedule
|
|
@statement_descriptor = statement_descriptor
|
|
end
|
|
end
|
|
|
|
class SettlementTiming < Stripe::RequestParams
|
|
# The number of days charge funds are held before becoming available. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `payouts.schedule.interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).
|
|
attr_accessor :delay_days_override
|
|
|
|
def initialize(delay_days_override: nil)
|
|
@delay_days_override = delay_days_override
|
|
end
|
|
end
|
|
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
|
|
attr_accessor :debit_negative_balances
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
# Settings specific to the account's payouts.
|
|
attr_accessor :payouts
|
|
# Settings related to the account's balance settlement timing.
|
|
attr_accessor :settlement_timing
|
|
|
|
def initialize(
|
|
debit_negative_balances: nil,
|
|
expand: nil,
|
|
payouts: nil,
|
|
settlement_timing: nil
|
|
)
|
|
@debit_negative_balances = debit_negative_balances
|
|
@expand = expand
|
|
@payouts = payouts
|
|
@settlement_timing = settlement_timing
|
|
end
|
|
end
|
|
|
|
# Retrieves balance settings for a given connected account.
|
|
# Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
|
|
def retrieve(params = {}, opts = {})
|
|
request(
|
|
method: :get,
|
|
path: "/v1/balance_settings",
|
|
params: params,
|
|
opts: opts,
|
|
base_address: :api
|
|
)
|
|
end
|
|
|
|
# Updates balance settings for a given connected account.
|
|
# Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
|
|
def update(params = {}, opts = {})
|
|
request(
|
|
method: :post,
|
|
path: "/v1/balance_settings",
|
|
params: params,
|
|
opts: opts,
|
|
base_address: :api
|
|
)
|
|
end
|
|
end
|
|
end
|