View Source Stripe.Token (stripity_stripe v3.1.1)

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 Custom accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.

Link to this section Summary

Types

account()

Details on the legal guardian's acceptance of the main Stripe service agreement.

additional_document()

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

additional_tos_acceptances()

Details on the legal guardian's acceptance of the required Stripe agreements.

address()

The person's address.

address_kana()

The Kana variation of the company's primary address (Japan only).

address_kanji()

The Kanji variation of the company's primary address (Japan only).

bank_account()

The bank account this token will represent.

card()

company()

Information about the company or business.

company_authorization()

One or more documents that demonstrate proof that this person is authorized to represent the company.

cvc_update()

The updated CVC value this token represents.

dob()

document()

A document verifying the business.

documents()

Documents that may be submitted to satisfy various informational requests.

individual()

Information about the person represented by the account.

ownership_declaration()

This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.

passport()

One or more documents showing the person's passport page with photo and personal data.

person()

Information for the person this token represents.

pii()

The PII this token represents.

registered_address()

The individual's registered address.

relationship()

The relationship that this person has with the account's legal entity.

t()

The token type.

verification()

Information on the verification state of the company.

visa()

One or more documents showing the person's visa required for living in the country where they are residing.

Functions

create(params \\ %{}, opts \\ [])

Creates a single-use token that represents a bank account’s details.You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

retrieve(token, params \\ %{}, opts \\ [])

Retrieves the token with the given ID.

Link to this section Types

account()

@type account() :: %{
  optional(:date) => integer(),
  optional(:ip) => binary(),
  optional(:user_agent) => binary() | binary()
}

Details on the legal guardian's acceptance of the main Stripe service agreement.

additional_document()

@type additional_document() :: %{
  optional(:back) => binary(),
  optional(:front) => binary()
}

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

additional_tos_acceptances()

@type additional_tos_acceptances() :: %{optional(:account) => account()}

Details on the legal guardian's acceptance of the required Stripe agreements.

address()

@type address() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary()
}

The person's address.

address_kana()

@type address_kana() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary(),
  optional(:town) => binary()
}

The Kana variation of the company's primary address (Japan only).

address_kanji()

@type address_kanji() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary(),
  optional(:town) => binary()
}

The Kanji variation of the company's primary address (Japan only).

bank_account()

@type bank_account() :: %{
  optional(:account_holder_name) => binary(),
  optional(:account_holder_type) => :company | :individual,
  optional(:account_number) => binary(),
  optional(:account_type) => :checking | :futsu | :savings | :toza,
  optional(:country) => binary(),
  optional(:currency) => binary(),
  optional(:routing_number) => binary()
}

The bank account this token will represent.

card()

@type card() :: %{
  optional(:address_city) => binary(),
  optional(:address_country) => binary(),
  optional(:address_line1) => binary(),
  optional(:address_line2) => binary(),
  optional(:address_state) => binary(),
  optional(:address_zip) => binary(),
  optional(:currency) => binary(),
  optional(:cvc) => binary(),
  optional(:exp_month) => binary(),
  optional(:exp_year) => binary(),
  optional(:name) => binary(),
  optional(:number) => binary()
}

company()

@type company() :: %{
  optional(:address) => address(),
  optional(:address_kana) => address_kana(),
  optional(:address_kanji) => address_kanji(),
  optional(:directors_provided) => boolean(),
  optional(:executives_provided) => boolean(),
  optional(:export_license_id) => binary(),
  optional(:export_purpose_code) => binary(),
  optional(:name) => binary(),
  optional(:name_kana) => binary(),
  optional(:name_kanji) => binary(),
  optional(:owners_provided) => boolean(),
  optional(:ownership_declaration) => ownership_declaration(),
  optional(:ownership_declaration_shown_and_signed) => boolean(),
  optional(:phone) => binary(),
  optional(:registration_number) => binary(),
  optional(:structure) =>
    :free_zone_establishment
    | :free_zone_llc
    | :government_instrumentality
    | :governmental_unit
    | :incorporated_non_profit
    | :incorporated_partnership
    | :limited_liability_partnership
    | :llc
    | :multi_member_llc
    | :private_company
    | :private_corporation
    | :private_partnership
    | :public_company
    | :public_corporation
    | :public_partnership
    | :single_member_llc
    | :sole_establishment
    | :sole_proprietorship
    | :tax_exempt_government_instrumentality
    | :unincorporated_association
    | :unincorporated_non_profit
    | :unincorporated_partnership,
  optional(:tax_id) => binary(),
  optional(:tax_id_registrar) => binary(),
  optional(:vat_id) => binary(),
  optional(:verification) => verification()
}

Information about the company or business.

company_authorization()

@type company_authorization() :: %{optional(:files) => [binary() | binary()]}

One or more documents that demonstrate proof that this person is authorized to represent the company.

cvc_update()

@type cvc_update() :: %{optional(:cvc) => binary()}

The updated CVC value this token represents.

dob()

@type dob() :: %{
  optional(:day) => integer(),
  optional(:month) => integer(),
  optional(:year) => integer()
}

document()

@type document() :: %{optional(:back) => binary(), optional(:front) => binary()}

A document verifying the business.

documents()

@type documents() :: %{
  optional(:company_authorization) => company_authorization(),
  optional(:passport) => passport(),
  optional(:visa) => visa()
}

Documents that may be submitted to satisfy various informational requests.

individual()

@type individual() :: %{
  optional(:address) => address(),
  optional(:address_kana) => address_kana(),
  optional(:address_kanji) => address_kanji(),
  optional(:dob) => dob() | binary(),
  optional(:email) => binary(),
  optional(:first_name) => binary(),
  optional(:first_name_kana) => binary(),
  optional(:first_name_kanji) => binary(),
  optional(:full_name_aliases) => [binary()] | binary(),
  optional(:gender) => binary(),
  optional(:id_number) => binary(),
  optional(:id_number_secondary) => binary(),
  optional(:last_name) => binary(),
  optional(:last_name_kana) => binary(),
  optional(:last_name_kanji) => binary(),
  optional(:maiden_name) => binary(),
  optional(:metadata) => %{optional(binary()) => binary()} | binary(),
  optional(:phone) => binary(),
  optional(:political_exposure) => :existing | :none,
  optional(:registered_address) => registered_address(),
  optional(:ssn_last_4) => binary(),
  optional(:verification) => verification()
}

Information about the person represented by the account.

ownership_declaration()

@type ownership_declaration() :: %{
  optional(:date) => integer(),
  optional(:ip) => binary(),
  optional(:user_agent) => binary()
}

This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.

passport()

@type passport() :: %{optional(:files) => [binary() | binary()]}

One or more documents showing the person's passport page with photo and personal data.

person()

@type person() :: %{
  optional(:additional_tos_acceptances) => additional_tos_acceptances(),
  optional(:address) => address(),
  optional(:address_kana) => address_kana(),
  optional(:address_kanji) => address_kanji(),
  optional(:dob) => dob() | binary(),
  optional(:documents) => documents(),
  optional(:email) => binary(),
  optional(:first_name) => binary(),
  optional(:first_name_kana) => binary(),
  optional(:first_name_kanji) => binary(),
  optional(:full_name_aliases) => [binary()] | binary(),
  optional(:gender) => binary(),
  optional(:id_number) => binary(),
  optional(:id_number_secondary) => binary(),
  optional(:last_name) => binary(),
  optional(:last_name_kana) => binary(),
  optional(:last_name_kanji) => binary(),
  optional(:maiden_name) => binary(),
  optional(:metadata) => %{optional(binary()) => binary()} | binary(),
  optional(:nationality) => binary(),
  optional(:phone) => binary(),
  optional(:political_exposure) => binary(),
  optional(:registered_address) => registered_address(),
  optional(:relationship) => relationship(),
  optional(:ssn_last_4) => binary(),
  optional(:verification) => verification()
}

Information for the person this token represents.

pii()

@type pii() :: %{optional(:id_number) => binary()}

The PII this token represents.

registered_address()

@type registered_address() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary()
}

The individual's registered address.

relationship()

@type relationship() :: %{
  optional(:director) => boolean(),
  optional(:executive) => boolean(),
  optional(:legal_guardian) => boolean(),
  optional(:owner) => boolean(),
  optional(:percent_ownership) => number() | binary(),
  optional(:representative) => boolean(),
  optional(:title) => binary()
}

The relationship that this person has with the account's legal entity.

t()

@type t() :: %Stripe.Token{
  bank_account: Stripe.BankAccount.t(),
  card: Stripe.Card.t(),
  client_ip: binary() | nil,
  created: integer(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  type: binary(),
  used: boolean()
}

The token type.

bank_account
card
client_ip IP address of the client that generates the token.
created Time at which the object was created. Measured in seconds since the Unix epoch.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
type Type of the token: account, bank_account, card, or pii.
used Determines if you have already used this token (you can only use tokens once).

verification()

@type verification() :: %{optional(:document) => document()}

Information on the verification state of the company.

visa()

@type visa() :: %{optional(:files) => [binary() | binary()]}

One or more documents showing the person's visa required for living in the country where they are residing.

Link to this section Functions

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:account) => account(),
    optional(:bank_account) => bank_account(),
    optional(:card) => card() | binary(),
    optional(:customer) => binary(),
    optional(:cvc_update) => cvc_update(),
    optional(:expand) => [binary()],
    optional(:person) => person(),
    optional(:pii) => pii()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

#### Details * Method: `post` * Path: `/v1/tokens`

retrieve(token, params \\ %{}, opts \\ [])

@spec retrieve(
  token :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the token with the given ID.

Details

Method: get
Path: /v1/tokens/{token}

Settings View Source Stripe.Token (stripity_stripe v3.1.1)

Link to this section Summary

Types

Functions

Link to this section Types

account()

additional_document()

additional_tos_acceptances()

address()

address_kana()

address_kanji()

bank_account()

card()

company()

company_authorization()

cvc_update()

dob()

document()

documents()

individual()

ownership_declaration()

passport()

person()

pii()

registered_address()

relationship()

t()

verification()

visa()

Link to this section Functions

create(params \\ %{}, opts \\ [])

retrieve(token, params \\ %{}, opts \\ [])

Details

View Source Stripe.Token (stripity_stripe v3.1.1)