Stripe.Params.BalanceSettingsUpdateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for balance settings update.

Summary

Types

payments()
payments_payouts()
payments_payouts_schedule()
payments_settlement_timing()
t()

Types

payments()

@type payments() :: %{
  optional(:debit_negative_balances) => boolean() | nil,
  optional(:payouts) => payments_payouts() | nil,
  optional(:settlement_timing) => payments_settlement_timing() | nil,
  optional(String.t()) => term()
}
  • debit_negative_balances - A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see Understanding Connect Account Balances.
  • payouts - Settings specific to the account's payouts.
  • settlement_timing - Settings related to the account's balance settlement timing.

payments_payouts()

@type payments_payouts() :: %{
  optional(:minimum_balance_by_currency) => map() | nil,
  optional(:schedule) => payments_payouts_schedule() | nil,
  optional(:statement_descriptor) => String.t() | nil,
  optional(String.t()) => term()
}
  • minimum_balance_by_currency - 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.
  • schedule - 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 documentation.
  • statement_descriptor - 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. Max length: 22.

payments_payouts_schedule()

@type payments_payouts_schedule() :: %{
  optional(:interval) => String.t() | nil,
  optional(:monthly_payout_days) => [integer()] | nil,
  optional(:weekly_payout_days) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • interval - How frequently available funds are paid out. One of: daily, manual, weekly, or monthly. Default is daily. Possible values: daily, manual, monthly, weekly.
  • monthly_payout_days - 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.
  • weekly_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.

payments_settlement_timing()

@type payments_settlement_timing() :: %{
  optional(:delay_days_override) => map() | nil,
  optional(String.t()) => term()
}
  • delay_days_override - Change delay_days for this account, which determines the number of days charge funds are held before becoming available. The maximum value is 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. Learn more about controlling delay days.

t()

@type t() :: %Stripe.Params.BalanceSettingsUpdateParams{
  expand: [String.t()] | nil,
  payments: payments() | nil
}
  • expand - Specifies which fields in the response should be expanded.
  • payments - Settings that apply to the Payments Balance.