Class: Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/setup_intent.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#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.



4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
 
# File 'lib/stripe/resources/setup_intent.rb', line 4363

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.



4347
4348
4349
 
# File 'lib/stripe/resources/setup_intent.rb', line 4347

def amount
  @amount
end

#amount_includes_iof ⇒ Object

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



4349
4350
4351
 
# File 'lib/stripe/resources/setup_intent.rb', line 4349

def amount_includes_iof
  @amount_includes_iof
end

#amount_type ⇒ Object

Type of amount. Defaults to ‘maximum`.



4351
4352
4353
 
# File 'lib/stripe/resources/setup_intent.rb', line 4351

def amount_type
  @amount_type
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Only ‘brl` is supported currently.



4353
4354
4355
 
# File 'lib/stripe/resources/setup_intent.rb', line 4353

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.



4355
4356
4357
 
# File 'lib/stripe/resources/setup_intent.rb', line 4355

def end_date
  @end_date
end

#payment_schedule ⇒ Object

Schedule at which the future payments will be charged. Defaults to ‘weekly`.



4357
4358
4359
 
# File 'lib/stripe/resources/setup_intent.rb', line 4357

def payment_schedule
  @payment_schedule
end

#reference ⇒ Object

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



4359
4360
4361
 
# File 'lib/stripe/resources/setup_intent.rb', line 4359

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.



4361
4362
4363
 
# File 'lib/stripe/resources/setup_intent.rb', line 4361

def start_date
  @start_date
end