class Stripe::ConfirmationToken

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

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def expires_at : Int64 | Nil #

[View source]
def expires_at=(new_value : Int64 | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def mandate_data : Stripe::ConfirmationTokenMandateData | Nil #

[View source]
def mandate_data=(new_value : Stripe::ConfirmationTokenMandateData | Nil) #

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


[View source]
def mandate_data_present=(mandate_data_present : Bool) #

[View source]
def mandate_data_present? : Bool #

[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def payment_intent : String | Nil #

[View source]
def payment_intent=(new_value : String | Nil) #

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


[View source]
def payment_method_options : Stripe::ConfirmationTokenPaymentMethodOptions | Nil #

[View source]
def 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


[View source]
def payment_method_preview : Stripe::ConfirmationTokenPaymentMethodPreview | Nil #

[View source]
def 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


[View source]
def return_url : String | Nil #

[View source]
def return_url=(new_value : String | Nil) #

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


[View source]
def setup_future_usage : String | Nil #

[View source]
def setup_future_usage=(new_value : String | Nil) #

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


[View source]
def setup_intent : String | Nil #

[View source]
def setup_intent=(new_value : String | Nil) #

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


[View source]
def shipping : Stripe::ConfirmationTokenShipping | Nil #

[View source]
def shipping=(new_value : Stripe::ConfirmationTokenShipping | Nil) #

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


[View source]
def use_stripe_sdk : Bool | Nil #

[View source]
def use_stripe_sdk=(new_value : Bool | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]