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

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #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_debitObject (readonly)

Attribute for field acss_debit



57
58
59
# File 'lib/stripe/resources/source_mandate_notification.rb', line 57

def acss_debit
  @acss_debit
end

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



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

def amount
  @amount
end

#bacs_debitObject (readonly)

Attribute for field bacs_debit



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

def bacs_debit
  @bacs_debit
end

#createdObject (readonly)

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



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

def created
  @created
end

#idObject (readonly)

Unique identifier for the object.



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

def id
  @id
end

#livemodeObject (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



67
68
69
# File 'lib/stripe/resources/source_mandate_notification.rb', line 67

def livemode
  @livemode
end

#objectObject (readonly)

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



69
70
71
# File 'lib/stripe/resources/source_mandate_notification.rb', line 69

def object
  @object
end

#reasonObject (readonly)

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



71
72
73
# File 'lib/stripe/resources/source_mandate_notification.rb', line 71

def reason
  @reason
end

#sepa_debitObject (readonly)

Attribute for field sepa_debit



73
74
75
# File 'lib/stripe/resources/source_mandate_notification.rb', line 73

def sepa_debit
  @sepa_debit
end

#sourceObject (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. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.

Related guides: Sources API and Sources & Customers.



84
85
86
# File 'lib/stripe/resources/source_mandate_notification.rb', line 84

def source
  @source
end

#statusObject (readonly)

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



86
87
88
# File 'lib/stripe/resources/source_mandate_notification.rb', line 86

def status
  @status
end

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



88
89
90
# File 'lib/stripe/resources/source_mandate_notification.rb', line 88

def type
  @type
end

Class Method Details

.field_remappingsObject



94
95
96
# File 'lib/stripe/resources/source_mandate_notification.rb', line 94

def self.field_remappings
  @field_remappings = {}
end

.inner_class_typesObject



90
91
92
# File 'lib/stripe/resources/source_mandate_notification.rb', line 90

def self.inner_class_types
  @inner_class_types = { acss_debit: AcssDebit, bacs_debit: BacsDebit, sepa_debit: SepaDebit }
end

.object_nameObject



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

def self.object_name
  "source_mandate_notification"
end