Class: Stripe::SourceMandateNotification
- Inherits:
-
APIResource
- Object
- StripeObject
- APIResource
- Stripe::SourceMandateNotification
- 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
-
#acss_debit ⇒ Object
readonly
Attribute for field acss_debit.
-
#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.
-
#bacs_debit ⇒ Object
readonly
Attribute for field bacs_debit.
-
#created ⇒ Object
readonly
Time at which the object was created.
-
#id ⇒ Object
readonly
Unique identifier for the object.
-
#livemode ⇒ Object
readonly
If the object exists in live mode, the value is
true. -
#object ⇒ Object
readonly
String representing the object's type.
-
#reason ⇒ Object
readonly
The reason of the mandate notification.
-
#sepa_debit ⇒ Object
readonly
Attribute for field sepa_debit.
-
#source ⇒ Object
readonly
Sourceobjects allow you to accept a variety of payment methods. -
#status ⇒ Object
readonly
The status of the mandate notification.
-
#type ⇒ Object
readonly
The type of source this mandate notification is attached to.
Attributes inherited from APIResource
Attributes inherited from StripeObject
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
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_debit ⇒ Object (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 |
#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.
59 60 61 |
# File 'lib/stripe/resources/source_mandate_notification.rb', line 59 def amount @amount end |
#bacs_debit ⇒ Object (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 |
#created ⇒ Object (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 |
#id ⇒ Object (readonly)
Unique identifier for the object.
65 66 67 |
# File 'lib/stripe/resources/source_mandate_notification.rb', line 65 def id @id end |
#livemode ⇒ Object (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 |
#object ⇒ Object (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 |
#reason ⇒ Object (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_debit ⇒ Object (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 |
#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. 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 |
#status ⇒ Object (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 |
#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.
88 89 90 |
# File 'lib/stripe/resources/source_mandate_notification.rb', line 88 def type @type end |
Class Method Details
.field_remappings ⇒ Object
94 95 96 |
# File 'lib/stripe/resources/source_mandate_notification.rb', line 94 def self.field_remappings @field_remappings = {} end |
.inner_class_types ⇒ Object
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_name ⇒ Object
10 11 12 |
# File 'lib/stripe/resources/source_mandate_notification.rb', line 10 def self.object_name "source_mandate_notification" end |