Package com.stripe.model

Class Token

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Token
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Token extends ApiResource implements HasId
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 External accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.

  • Constructor Details

    • Token

      public Token()

  • Method Details

    • create

      public static Token create(Map<String,Object> params) throws StripeException
      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 connected account where controller.requirement_collection is application, which includes Custom accounts.
      Throws:
      StripeException

    • create

      public static Token create(Map<String,Object> params, RequestOptions options) throws StripeException
      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 connected account where controller.requirement_collection is application, which includes Custom accounts.
      Throws:
      StripeException

    • create

      public static Token create(TokenCreateParams params) throws StripeException
      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 connected account where controller.requirement_collection is application, which includes Custom accounts.
      Throws:
      StripeException

    • create

      public static Token create(TokenCreateParams params, RequestOptions options) throws StripeException
      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 connected account where controller.requirement_collection is application, which includes Custom accounts.
      Throws:
      StripeException

    • retrieve

      public static Token retrieve(String token) throws StripeException
      Retrieves the token with the given ID.
      Throws:
      StripeException

    • retrieve

      public static Token retrieve(String token, RequestOptions options) throws StripeException
      Retrieves the token with the given ID.
      Throws:
      StripeException

    • retrieve

      public static Token retrieve(String token, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the token with the given ID.
      Throws:
      StripeException

    • retrieve

      public static Token retrieve(String token, TokenRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the token with the given ID.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getBankAccount

      public BankAccount getBankAccount()
      These bank accounts are payment methods on Customer objects.

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

      Related guide: Bank debits and transfers

    • getCard

      public Card getCard()
      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

    • getClientIp

      public String getClientIp()
      IP address of the client that generates the token.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to token.

    • getType

      public String getType()
      Type of the token: account, bank_account, card, or pii.

    • getUsed

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

    • setBankAccount

      public void setBankAccount(BankAccount bankAccount)
      These bank accounts are payment methods on Customer objects.

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

      Related guide: Bank debits and transfers

    • setCard

      public void setCard(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

    • setClientIp

      public void setClientIp(String clientIp)
      IP address of the client that generates the token.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to token.

    • setType

      public void setType(String type)
      Type of the token: account, bank_account, card, or pii.

    • setUsed

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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId