Class: Stripe::Mandate
- Inherits:
-
APIResource
- Object
- StripeObject
- APIResource
- Stripe::Mandate
- Defined in:
- lib/stripe/resources/mandate.rb
Overview
A Mandate is a record of the permission that your customer gives you to debit their payment method.
Defined Under Namespace
Classes: CustomerAcceptance, MultiUse, PaymentMethodDetails, SingleUse
Constant Summary collapse
- OBJECT_NAME =
"mandate"
Constants inherited from StripeObject
StripeObject::RESERVED_FIELD_NAMES
Instance Attribute Summary collapse
-
#customer_acceptance ⇒ Object
readonly
Attribute for field customer_acceptance.
-
#id ⇒ Object
readonly
Unique identifier for the object.
-
#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.
-
#multi_use ⇒ Object
readonly
Attribute for field multi_use.
-
#object ⇒ Object
readonly
String representing the object’s type.
-
#on_behalf_of ⇒ Object
readonly
The account (if any) that the mandate is intended for.
-
#payment_method ⇒ Object
readonly
ID of the payment method associated with this mandate.
-
#payment_method_details ⇒ Object
readonly
Attribute for field payment_method_details.
-
#single_use ⇒ Object
readonly
Attribute for field single_use.
-
#status ⇒ Object
readonly
The mandate status indicates whether or not you can use it to initiate a payment.
-
#type ⇒ Object
readonly
The type of the mandate.
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
#==, #[], #[]=, 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
#customer_acceptance ⇒ Object (readonly)
Attribute for field customer_acceptance
132 133 134 |
# File 'lib/stripe/resources/mandate.rb', line 132 def customer_acceptance @customer_acceptance end |
#id ⇒ Object (readonly)
Unique identifier for the object.
134 135 136 |
# File 'lib/stripe/resources/mandate.rb', line 134 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.
136 137 138 |
# File 'lib/stripe/resources/mandate.rb', line 136 def livemode @livemode end |
#multi_use ⇒ Object (readonly)
Attribute for field multi_use
138 139 140 |
# File 'lib/stripe/resources/mandate.rb', line 138 def multi_use @multi_use end |
#object ⇒ Object (readonly)
String representing the object’s type. Objects of the same type share the same value.
140 141 142 |
# File 'lib/stripe/resources/mandate.rb', line 140 def object @object end |
#on_behalf_of ⇒ Object (readonly)
The account (if any) that the mandate is intended for.
142 143 144 |
# File 'lib/stripe/resources/mandate.rb', line 142 def on_behalf_of @on_behalf_of end |
#payment_method ⇒ Object (readonly)
ID of the payment method associated with this mandate.
144 145 146 |
# File 'lib/stripe/resources/mandate.rb', line 144 def payment_method @payment_method end |
#payment_method_details ⇒ Object (readonly)
Attribute for field payment_method_details
146 147 148 |
# File 'lib/stripe/resources/mandate.rb', line 146 def payment_method_details @payment_method_details end |
#single_use ⇒ Object (readonly)
Attribute for field single_use
148 149 150 |
# File 'lib/stripe/resources/mandate.rb', line 148 def single_use @single_use end |
#status ⇒ Object (readonly)
The mandate status indicates whether or not you can use it to initiate a payment.
150 151 152 |
# File 'lib/stripe/resources/mandate.rb', line 150 def status @status end |
#type ⇒ Object (readonly)
The type of the mandate.
152 153 154 |
# File 'lib/stripe/resources/mandate.rb', line 152 def type @type end |
Class Method Details
.object_name ⇒ Object
8 9 10 |
# File 'lib/stripe/resources/mandate.rb', line 8 def self.object_name "mandate" end |