StripeAPI.Types.Token

Contains the types generated from the schema Token

Documentation

data Token

Defines the object schema located at components.schemas.token in the specification.

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. This 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.

Related guide: Accept a payment

Constructors

Token

Fields

• tokenBankAccount :: Maybe BankAccount

  bank_account: These bank accounts are payment methods on `Customer` objects.

  On the other hand External Accounts are transfer destinations on `Account` objects for Custom accounts. They can be bank accounts or debit cards as well, and are documented in the links above.

  Related guide: Bank Debits and Transfers.

• tokenCard :: Maybe Card

  card: You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.

  Related guide: Card Payments with Sources.

• tokenClientIp :: Maybe Text

  client_ip: IP address of the client that generated the token.

  Constraints:

  • Maximum length of 5000
• tokenCreated :: Int

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

• tokenId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• tokenLivemode :: Bool

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

• tokenType :: Text

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

  Constraints:

  • Maximum length of 5000
• tokenUsed :: Bool

  used: Whether this token has already been used (tokens can be used only once).

Instances

Eq Token

Defined in StripeAPI.Types.Token

Methods

(==) :: Token -> Token -> Bool

(/=) :: Token -> Token -> Bool

Show Token

Defined in StripeAPI.Types.Token

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

ToJSON Token

Defined in StripeAPI.Types.Token

Methods

toJSON :: Token -> Value

toEncoding :: Token -> Encoding

toJSONList :: [Token] -> Value

toEncodingList :: [Token] -> Encoding

FromJSON Token

Defined in StripeAPI.Types.Token

Methods

parseJSON :: Value -> Parser Token

parseJSONList :: Value -> Parser [Token]

mkToken

Arguments

:: Int

tokenCreated

-> Text

tokenId

-> Bool

tokenLivemode

-> Text

tokenType

-> Bool

tokenUsed

-> Token

Create a new Token with all required fields.