class Stripe::ConfirmationToken

• Stripe::ConfirmationToken
• Reference
• Object

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/confirmation_token.cr

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expires_at : Int64 | Nil
• #expires_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #mandate_data : Stripe::ConfirmationTokenMandateData | Nil
• #mandate_data=(new_value : Stripe::ConfirmationTokenMandateData | Nil)

  Custom attribute writer method checking allowed values (enum).

• #mandate_data_present=(mandate_data_present : Bool)
• #mandate_data_present? : Bool
• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_intent : String | Nil
• #payment_intent=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_options : Stripe::ConfirmationTokenPaymentMethodOptions | Nil
• #payment_method_options=(new_value : Stripe::ConfirmationTokenPaymentMethodOptions | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_preview : Stripe::ConfirmationTokenPaymentMethodPreview | Nil
• #payment_method_preview=(new_value : Stripe::ConfirmationTokenPaymentMethodPreview | Nil)

  Custom attribute writer method checking allowed values (enum).

• #return_url : String | Nil
• #return_url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #setup_future_usage : String | Nil
• #setup_future_usage=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #setup_intent : String | Nil
• #setup_intent=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping : Stripe::ConfirmationTokenShipping | Nil
• #shipping=(new_value : Stripe::ConfirmationTokenShipping | Nil)

  Custom attribute writer method checking allowed values (enum).

• #use_stripe_sdk : Bool | Nil
• #use_stripe_sdk=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail