class

Stripe::ConfirmationToken

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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: - Finalize payments on the server - Build two-step confirmation.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [confirmation_token]."
ERROR_MESSAGE_FOR_SETUP_FUTURE_USAGE = "invalid value for \"setup_future_usage\", must be one of [off_session, on_session]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_PAYMENT_INTENT = 5000
MAX_LENGTH_FOR_RETURN_URL = 5000
MAX_LENGTH_FOR_SETUP_INTENT = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("confirmation_token")
VALID_VALUES_FOR_SETUP_FUTURE_USAGE = String.static_array("off_session", "on_session")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, created : Int64 | Nil = nil, expires_at : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, payment_intent : String | Nil = nil, payment_method_options : Stripe::ConfirmationTokenPaymentMethodOptions | Nil = nil, payment_method_preview : Stripe::ConfirmationTokenPaymentMethodPreview | Nil = nil, return_url : String | Nil = nil, setup_future_usage : String | Nil = nil, setup_intent : String | Nil = nil, shipping : Stripe::ConfirmationTokenShipping | Nil = nil, use_stripe_sdk : Bool | Nil = nil, mandate_data : Stripe::ConfirmationTokenMandateData | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

created

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

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
expires_at

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

Source
expires_at=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expires_at Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
mandate_data
Source
mandate_data=(new_value : Stripe::ConfirmationTokenMandateData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] mandate_data Object to be assigned

Source
mandate_data_present=(mandate_data_present : Bool)
Source
mandate_data_present?
Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
payment_intent

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

Source
payment_intent=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_intent Object to be assigned

Source
payment_method_options
Source
payment_method_options=(new_value : Stripe::ConfirmationTokenPaymentMethodOptions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_options Object to be assigned

Source
payment_method_preview
Source
payment_method_preview=(new_value : Stripe::ConfirmationTokenPaymentMethodPreview | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_preview Object to be assigned

Source
return_url

Return URL used to confirm the Intent.

Source
return_url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] return_url Object to be assigned

Source
setup_future_usage

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.

Source
setup_future_usage=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] setup_future_usage Object to be assigned

Source
setup_intent

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

Source
setup_intent=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] setup_intent Object to be assigned

Source
shipping
Source
shipping=(new_value : Stripe::ConfirmationTokenShipping | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] shipping Object to be assigned

Source
use_stripe_sdk

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

Source
use_stripe_sdk=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] use_stripe_sdk Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source