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, #_get_union_variant_class, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, inner_class_union_variant_types, #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.



1770
1771
1772
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1770

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.



1772
1773
1774
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1772

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1774
1775
1776
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1774

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.



1776
1777
1778
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1776

def livemode
  @livemode
end

#mandate_data ⇒ Object (readonly)

Data used for generating a Mandate.



1778
1779
1780
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1778

def mandate_data
  @mandate_data
end

#metadata ⇒ Object (readonly)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



1780
1781
1782
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1780

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



1782
1783
1784
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1782

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.



1784
1785
1786
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1784

def payment_intent
  @payment_intent
end

#payment_method_options ⇒ Object (readonly)

Payment-method-specific configuration for this ConfirmationToken.



1786
1787
1788
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1786

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.



1788
1789
1790
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1788

def payment_method_preview
  @payment_method_preview
end

#return_url ⇒ Object (readonly)

Return URL used to confirm the Intent.



1790
1791
1792
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1790

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 to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.



1794
1795
1796
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1794

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.



1796
1797
1798
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1796

def setup_intent
  @setup_intent
end

#shipping ⇒ Object (readonly)

Shipping information collected on this ConfirmationToken.



1798
1799
1800
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1798

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.



1800
1801
1802
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1800

def use_stripe_sdk
  @use_stripe_sdk
end

Class Method Details

.field_remappings ⇒ Object 



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

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1823
1824
1825
1826
1827
1828
1829
1830
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1823

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 



1802
1803
1804
 
# File 'lib/stripe/resources/confirmation_token.rb', line 1802

def test_helpers
  TestHelpers.new(self)
end