Class: Stripe::SourceMandateNotification

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/source_mandate_notification.rb

Overview

Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer.

Defined Under Namespace

Classes: AcssDebit, BacsDebit, SepaDebit

Constant Summary collapse

OBJECT_NAME = 
"source_mandate_notification"

Constants inherited from StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#acss_debit ⇒ Object (readonly)

Attribute for field acss_debit



33
34
35
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 33

def acss_debit
  @acss_debit
end

#amount ⇒ Object (readonly)

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is ‘debit_initiated`.



35
36
37
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 35

def amount
  @amount
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



37
38
39
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 37

def bacs_debit
  @bacs_debit
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



39
40
41
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 39

def created
  @created
end

#id ⇒ Object (readonly)

Unique identifier for the object.



41
42
43
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 41

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



43
44
45
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 43

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



45
46
47
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 45

def object
  @object
end

#reason ⇒ Object (readonly)

The reason of the mandate notification. Valid reasons are ‘mandate_confirmed` or `debit_initiated`.



47
48
49
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 47

def reason
  @reason
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



49
50
51
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 49

def sepa_debit
  @sepa_debit
end

#source ⇒ Object (readonly)

‘Source` objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like a ‘Card` object: once chargeable, they can be charged, or can be attached to customers.

Stripe doesn’t recommend using the deprecated [Sources API](stripe.com/docs/api/sources). We recommend that you adopt the [PaymentMethods API](stripe.com/docs/api/payment_methods). This newer API provides access to our latest features and payment method types.

Related guides: [Sources API](stripe.com/docs/sources) and [Sources & Customers](stripe.com/docs/sources/customers).



60
61
62
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 60

def source
  @source
end

#status ⇒ Object (readonly)

The status of the mandate notification. Valid statuses are ‘pending` or `submitted`.



62
63
64
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 62

def status
  @status
end

#type ⇒ Object (readonly)

The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as ‘three_d_secure`.



64
65
66
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 64

def type
  @type
end

Class Method Details

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/source_mandate_notification.rb', line 10

def self.object_name
  "source_mandate_notification"
end