The Token object 

Attributes

• idstring

  Unique identifier for the object.

• cardnullable object

  Hash describing the card used to make the charge.

  Hide child attributes

  • card.idstring

    Unique identifier for the object.

  • card.objectstring

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

  • card.address_citynullable string

    City/District/Suburb/Town/Village.

  • card.address_countrynullable string

    Billing address country, if provided when creating card.

  • card.address_line1nullable string

    Address line 1 (Street address/PO Box/Company name).

  • card.address_line1_checknullable string

    If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

  • card.address_line2nullable string

    Address line 2 (Apartment/Suite/Unit/Building).

  • card.address_statenullable string

    State/County/Province/Region.

  • card.address_zipnullable string

    ZIP or postal code.

  • card.address_zip_checknullable string

    If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

  • card.brandstring

    Card brand. Can be American Express, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa, or Unknown.

  • card.countrynullable string

    Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

  • card.currencynullable enum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • card.cvc_checknullable string

    If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn’t been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  • card.dynamic_last4nullable string

    (For tokenized numbers only.) The last four digits of the device account number.

  • card.exp_monthinteger

    Two-digit number representing the card’s expiration month.

  • card.exp_yearinteger

    Four-digit number representing the card’s expiration year.

  • card.fingerprintnullable string

    Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

    As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

  • card.fundingstring

    Card funding type. Can be credit, debit, prepaid, or unknown.

  • card.iinnullable string

    Issuer identification number of the card.

  • card.last4string

    The last four digits of the card.

  • card.metadatanullable object

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • card.namenullable string

    Cardholder name.

  • card.networksnullable object

    Contains information about card networks used to process the payment.

    Hide child attributes

    • card.networks.preferrednullable string

      The preferred network for co-branded cards. Can be cartes_bancaires, mastercard, visa or invalid_preference if requested network is not valid for the card.

  • card.regulated_statusnullable enum

    Status of a card based on the card issuer.

    Possible enum values

    regulated The card falls under a regulated account range.

    unregulated The card does not fall under a regulated account range.

  • card.tokenization_methodnullable string

    If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.

  • card.walletnullable objectPreview feature

    If this Card is part of a card wallet, this contains the details of the card wallet.

    Hide child attributes

    • card.wallet.apple_paynullable object

      If this is a apple_pay card wallet, this hash contains details about the wallet.

    • card.wallet.typeenum

      The type of the card wallet, one of apple_pay or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.

      Possible enum values

      apple_pay

      link

More attributes

Collapse all

• objectstring

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

• bank_accountnullable object

  Hash describing the bank account.

  Hide child attributes

  • bank_account.idstring

    Unique identifier for the object.

  • bank_account.objectstring

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

  • bank_account.account_holder_namenullable string

    The name of the person or business that owns the bank account.

  • bank_account.account_holder_typenullable string

    The type of entity that holds the account. This can be either individual or company.

  • bank_account.account_typenullable string

    The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

  • bank_account.bank_namenullable string

    Name of the bank associated with the routing number (e.g., WELLS FARGO).

  • bank_account.countrystring

    Two-letter ISO code representing the country the bank account is located in.

  • bank_account.currencyenum

    Three-letter ISO code for the currency paid out to the bank account.

  • bank_account.fingerprintnullable string

    Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

  • bank_account.last4string

    The last four digits of the bank account number.

  • bank_account.routing_numbernullable string

    The routing transit number for the bank account.

  • bank_account.statusstring

    For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn’t had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a payout sent to this bank account fails, we’ll set the status to errored and will not continue to send scheduled payouts until the bank details are updated.

    For external accounts, possible values are new, errored and verification_failed. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated. In the US and India, if we can’t verify the owner of the bank account, we’ll set the status to verification_failed. Other validations aren’t run against external accounts because they’re only used for payouts. This means the other statuses don’t apply.

• client_ipnullable string

  IP address of the client that generates the token.

• createdtimestamp

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

• descriptionnullable string

  An arbitrary string attached to the object. Often useful for displaying to users.

• livemodeboolean

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

• typestring

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

• usedboolean

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