class

Stripe::Token

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

Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way. If you can't use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, you're responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer's information isn't sent directly to Stripe, so we can't determine how it's handled or stored. You can't store or use tokens more than once. To store card or bank account information for later use, create Customer objects or External accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [token]."
MAX_LENGTH_FOR__TYPE = 5000
MAX_LENGTH_FOR_CLIENT_IP = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("token")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, client_ip : String | Nil = nil, created : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, _type : String | Nil = nil, used : Bool | Nil = nil, bank_account : Stripe::BankAccount | Nil = nil, card : Stripe::Card | 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

_type

Type of the token: account, bank_account, card, or pii.

Source
_type=(new_value : String | Nil)

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

Source
bank_account
Source
bank_account=(new_value : Stripe::BankAccount | Nil)

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

Source
card
Source
card=(new_value : Stripe::Card | Nil)

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

Source
client_ip

IP address of the client that generates the token.

Source
client_ip=(new_value : String | Nil)

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

Source
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
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
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
used

Determines if you have already used this token (you can only use tokens once).

Source
used=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] used 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