Class: Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::Pix::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/payment_intent_confirm_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(amount: nil, amount_includes_iof: nil, amount_type: nil, currency: nil, end_date: nil, payment_schedule: nil, reference: nil, start_date: nil) ⇒ MandateOptions

Returns a new instance of MandateOptions.



2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2066

def initialize(
  amount: nil,
  amount_includes_iof: nil,
  amount_type: nil,
  currency: nil,
  end_date: nil,
  payment_schedule: nil,
  reference: nil,
  start_date: nil
)
  @amount = amount
  @amount_includes_iof = amount_includes_iof
  @amount_type = amount_type
  @currency = currency
  @end_date = end_date
  @payment_schedule = payment_schedule
  @reference = reference
  @start_date = start_date
end

Instance Attribute Details

#amount ⇒ Object

Amount to be charged for future payments. Required when amount_type=fixed. If not provided for amount_type=maximum, defaults to 40000.



2050
2051
2052
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2050

def amount
  @amount
end

#amount_includes_iof ⇒ Object

Determines if the amount includes the IOF tax. Defaults to never.



2052
2053
2054
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2052

def amount_includes_iof
  @amount_includes_iof
end

#amount_type ⇒ Object

Type of amount. Defaults to maximum.



2054
2055
2056
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2054

def amount_type
  @amount_type
end

#currency ⇒ Object

Three-letter ISO currency code, in lowercase. Only brl is supported currently.



2056
2057
2058
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2056

def currency
  @currency
end

#end_date ⇒ Object

Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.



2058
2059
2060
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2058

def end_date
  @end_date
end

#payment_schedule ⇒ Object

Schedule at which the future payments will be charged. Defaults to monthly.



2060
2061
2062
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2060

def payment_schedule
  @payment_schedule
end

#reference ⇒ Object

Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.



2062
2063
2064
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2062

def reference
  @reference
end

#start_date ⇒ Object

Start date of the mandate, in YYYY-MM-DD. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.



2064
2065
2066
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2064

def start_date
  @start_date
end