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?, 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

#created ⇒ Object (readonly)

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



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

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.



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

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



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

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`.



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

def livemode
  @livemode
end

#mandate_data ⇒ Object (readonly)

Data used for generating a Mandate.



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

def mandate_data
  @mandate_data
end

#object ⇒ Object (readonly)

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



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

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.



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

def payment_intent
  @payment_intent
end

#payment_method_options ⇒ Object (readonly)

Payment-method-specific configuration for this ConfirmationToken.



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

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.



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

def payment_method_preview
  @payment_method_preview
end

#return_url ⇒ Object (readonly)

Return URL used to confirm the Intent.



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

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.



1862
1863
1864
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1862

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.



1864
1865
1866
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1864

def setup_intent
  @setup_intent
end

#shipping ⇒ Object (readonly)

Shipping information collected on this ConfirmationToken.



1866
1867
1868
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1866

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.



1868
1869
1870
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1868

def use_stripe_sdk
  @use_stripe_sdk
end

Class Method Details

.field_remappings ⇒ Object 



1900
1901
1902
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1900

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1891

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 



1870
1871
1872
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1870

def test_helpers
  TestHelpers.new(self)
end