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

#==, #[], #[]=, #_get_inner_class_type, 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.



1827
1828
1829
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1827

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.



1829
1830
1831
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1829

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1831
1832
1833
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1831

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.



1833
1834
1835
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1833

def livemode
  @livemode
end

#mandate_data ⇒ Object (readonly)

Data used for generating a Mandate.



1835
1836
1837
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1835

def mandate_data
  @mandate_data
end

#object ⇒ Object (readonly)

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



1837
1838
1839
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1837

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.



1839
1840
1841
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1839

def payment_intent
  @payment_intent
end

#payment_method_options ⇒ Object (readonly)

Payment-method-specific configuration for this ConfirmationToken.



1841
1842
1843
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1841

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.



1843
1844
1845
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1843

def payment_method_preview
  @payment_method_preview
end

#return_url ⇒ Object (readonly)

Return URL used to confirm the Intent.



1845
1846
1847
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1845

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](docs.stripe.com/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.



1849
1850
1851
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1849

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.



1851
1852
1853
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1851

def setup_intent
  @setup_intent
end

#shipping ⇒ Object (readonly)

Shipping information collected on this ConfirmationToken.



1853
1854
1855
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1853

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.



1855
1856
1857
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1855

def use_stripe_sdk
  @use_stripe_sdk
end

Class Method Details

.field_remappings ⇒ Object 



1887
1888
1889
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1887

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1878

def self.inner_class_types
  @inner_class_types = {
    mandate_data: MandateData,
    payment_method_options: PaymentMethodOptions,
    payment_method_preview: PaymentMethodPreview,
    shipping: Shipping,
  }
end

.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 



1857
1858
1859
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1857

def test_helpers
  TestHelpers.new(self)
end