exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Token (exoapi_stripe v0.1.4)

description: 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

:bank_account :: ExOAPI.Stripe.Schemas.BankAccount

:card :: ExOAPI.Stripe.Schemas.Card

:client_ip :: :string

IP address of the client that generated the token.

:created :: :integer

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

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

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

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:type :: :string

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

:used :: :boolean

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

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Token{
  bank_account: ExOAPI.Stripe.Schemas.BankAccount.t() | nil,
  card: ExOAPI.Stripe.Schemas.Card.t() | nil,
  client_ip: String.t() | nil,
  created: integer() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  object: :token | nil,
  type: String.t() | nil,
  used: boolean() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()