Token class
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. You should use our recommended payments integrations to perform this process client-side. T his ensures that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.
If you cannot use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. Keep in mind that if your integration uses this method, you are responsible for any PCI compliance that may be required, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer's information is not sent directly to Stripe, so we cannot determine how it is handled or stored.
Tokens cannot be stored or used more than once. To store card or bank account information for later use, you can create Customer objects or Custom accounts. Note that Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.
- Annotations
-
- @freezed
Constructors
- Token({required String id, @Default("token") String object, @JsonKey(name: "bank_account") BankAccountToken? bankAccount, CardToken? card, @JsonKey(name: "client_ip") String? clientIP, int? created, @Default(true) bool livemode, required TokenType type, @Default(false) bool used})
-
constfactory
-
Token.fromJson(Map<
String, dynamic> json) -
factory
Properties
- bankAccount → BankAccountToken?
-
Hash describing the bank account.
no setterinherited
- card → CardToken?
-
Hash describing the card used to make the charge.
no setterinherited
- clientIP → String?
-
IP address of the client that generated the token.
no setterinherited
-
copyWith
→ $TokenCopyWith<
Token> -
no setterinherited
- created → int?
-
Time at which the object was created. Measured in seconds since the Unix epoch.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Unique identifier for the object.
no setterinherited
- livemode → bool
-
Type of the token: account, bank_account, card, or pii.
no setterinherited
- object → String
-
String representing the object’s type.
Objects of the same type share the same value.
Value is "token".
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → TokenType
-
Has the value true if the object exists in live mode or the
value false if the object exists in test mode.
no setterinherited
- used → bool
-
Whether this token has already been used
(tokens can be used only once).
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited