Class: Stripe::ConfirmationToken

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

Overview

ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.

To learn more about how to use ConfirmationToken, visit the related guides:

Defined Under Namespace

Classes: MandateData, PaymentMethodOptions, PaymentMethodPreview, Shipping, TestHelpers

Constant Summary collapse

OBJECT_NAME = 
"confirmation_token"

Constants inherited from StripeObject

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

Instance 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

#created ⇒ Object (readonly)

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



285
286
287
 
# File 'lib/stripe/resources/confirmation_token.rb', line 285

def created
  @created
end

#expires_at ⇒ Object (readonly)

Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.



287
288
289
 
# File 'lib/stripe/resources/confirmation_token.rb', line 287

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



289
290
291
 
# File 'lib/stripe/resources/confirmation_token.rb', line 289

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.



291
292
293
 
# File 'lib/stripe/resources/confirmation_token.rb', line 291

def livemode
  @livemode
end

#mandate_data ⇒ Object (readonly)

Data used for generating a Mandate.



293
294
295
 
# File 'lib/stripe/resources/confirmation_token.rb', line 293

def mandate_data
  @mandate_data
end

#object ⇒ Object (readonly)

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



295
296
297
 
# File 'lib/stripe/resources/confirmation_token.rb', line 295

def object
  @object
end

#payment_intent ⇒ Object (readonly)

ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.



297
298
299
 
# File 'lib/stripe/resources/confirmation_token.rb', line 297

def payment_intent
  @payment_intent
end

#payment_method_options ⇒ Object (readonly)

Payment-method-specific configuration for this ConfirmationToken.



299
300
301
 
# File 'lib/stripe/resources/confirmation_token.rb', line 299

def payment_method_options
  @payment_method_options
end

#payment_method_preview ⇒ Object (readonly)

Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.



301
302
303
 
# File 'lib/stripe/resources/confirmation_token.rb', line 301

def payment_method_preview
  @payment_method_preview
end

#return_url ⇒ Object (readonly)

Return URL used to confirm the Intent.



303
304
305
 
# File 'lib/stripe/resources/confirmation_token.rb', line 303

def return_url
  @return_url
end

#setup_future_usage ⇒ Object (readonly)

Indicates that you intend to make future payments with this ConfirmationToken’s payment method.

The presence of this property will [attach the payment method](stripe.com/docs/payments/save-during-payment) to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.



307
308
309
 
# File 'lib/stripe/resources/confirmation_token.rb', line 307

def setup_future_usage
  @setup_future_usage
end

#setup_intent ⇒ Object (readonly)

ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.



309
310
311
 
# File 'lib/stripe/resources/confirmation_token.rb', line 309

def setup_intent
  @setup_intent
end

#shipping ⇒ Object (readonly)

Shipping information collected on this ConfirmationToken.



311
312
313
 
# File 'lib/stripe/resources/confirmation_token.rb', line 311

def shipping
  @shipping
end

#use_stripe_sdk ⇒ Object (readonly)

Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to ‘true` on ConfirmationToken.



313
314
315
 
# File 'lib/stripe/resources/confirmation_token.rb', line 313

def use_stripe_sdk
  @use_stripe_sdk
end

Class Method Details

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/confirmation_token.rb', line 14

def self.object_name
  "confirmation_token"
end

Instance Method Details

#test_helpers ⇒ Object 



315
316
317
 
# File 'lib/stripe/resources/confirmation_token.rb', line 315

def test_helpers
  TestHelpers.new(self)
end