Class: Stripe::Source::CreateParams::Mandate

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/source.rb

Defined Under Namespace

Classes: Acceptance

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(acceptance: nil, amount: nil, currency: nil, interval: nil, notification_method: nil) ⇒ Mandate

Returns a new instance of Mandate.



892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/stripe/resources/source.rb', line 892

def initialize(
  acceptance: nil,
  amount: nil,
  currency: nil,
  interval: nil,
  notification_method: nil
)
  @acceptance = acceptance
  @amount = amount
  @currency = currency
  @interval = interval
  @notification_method = notification_method
end

Instance Attribute Details

#acceptance ⇒ Object

The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.



882
883
884
 
# File 'lib/stripe/resources/source.rb', line 882

def acceptance
  @acceptance
end

#amount ⇒ Object

The amount specified by the mandate. (Leave null for a mandate covering all amounts)



884
885
886
 
# File 'lib/stripe/resources/source.rb', line 884

def amount
  @amount
end

#currency ⇒ Object

The currency specified by the mandate. (Must match ‘currency` of the source)



886
887
888
 
# File 'lib/stripe/resources/source.rb', line 886

def currency
  @currency
end

#interval ⇒ Object

The interval of debits permitted by the mandate. Either ‘one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)



888
889
890
 
# File 'lib/stripe/resources/source.rb', line 888

def interval
  @interval
end

#notification_method ⇒ Object

The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either ‘email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).



890
891
892
 
# File 'lib/stripe/resources/source.rb', line 890

def notification_method
  @notification_method
end