com.stripe.model

Class Token

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.Token

All Implemented Interfaces:

HasId, StripeObjectInterface

public class Token
extends ApiResource
implements HasId

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Token()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
static Token	create(java.util.Map<java.lang.String,java.lang.Object> params) Creates a single-use token that represents a bank account’s details.
static Token	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Creates a single-use token that represents a bank account’s details.
static Token	create(TokenCreateParams params) Creates a single-use token that represents a bank account’s details.
static Token	create(TokenCreateParams params, RequestOptions options) Creates a single-use token that represents a bank account’s details.
boolean	equals(java.lang.Object o)
BankAccount	getBankAccount() These bank accounts are payment methods on Customer objects.
Card	getCard() You can store multiple cards on a customer in order to charge the customer later.
java.lang.String	getClientIp() IP address of the client that generated the token.
java.lang.Long	getCreated() Time at which the object was created.
java.lang.String	getId() Unique identifier for the object.
java.lang.Boolean	getLivemode() Has the value true if the object exists in live mode or the value false if the object exists in test mode.
java.lang.String	getObject() String representing the object's type.
java.lang.String	getType() Type of the token: account, bank_account, card, or pii.
java.lang.Boolean	getUsed() Whether this token has already been used (tokens can be used only once).
int	hashCode()
static Token	retrieve(java.lang.String token) Retrieves the token with the given ID.
static Token	retrieve(java.lang.String token, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrieves the token with the given ID.
static Token	retrieve(java.lang.String token, RequestOptions options) Retrieves the token with the given ID.
static Token	retrieve(java.lang.String token, TokenRetrieveParams params, RequestOptions options) Retrieves the token with the given ID.
void	setBankAccount(BankAccount bankAccount) These bank accounts are payment methods on Customer objects.
void	setCard(Card card) You can store multiple cards on a customer in order to charge the customer later.
void	setClientIp(java.lang.String clientIp) IP address of the client that generated the token.
void	setCreated(java.lang.Long created) Time at which the object was created.
void	setId(java.lang.String id) Unique identifier for the object.
void	setLivemode(java.lang.Boolean livemode) Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setObject(java.lang.String object) String representing the object's type.
void	setType(java.lang.String type) Type of the token: account, bank_account, card, or pii.
void	setUsed(java.lang.Boolean used) Whether this token has already been used (tokens can be used only once).

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Token

public Token()

Method Detail

retrieve

public static Token retrieve(java.lang.String token)
                      throws StripeException

Retrieves the token with the given ID.

Throws:

StripeException

retrieve

public static Token retrieve(java.lang.String token,
                             RequestOptions options)
                      throws StripeException

Retrieves the token with the given ID.

Throws:

StripeException

retrieve

public static Token retrieve(java.lang.String token,
                             java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException

Retrieves the token with the given ID.

Throws:

StripeException

retrieve

public static Token retrieve(java.lang.String token,
                             TokenRetrieveParams params,
                             RequestOptions options)
                      throws StripeException

Retrieves the token with the given ID.

Throws:

StripeException

create

public static Token create(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException

Creates a single-use token that represents a bank account’s details. This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

Throws:

StripeException

create

public static Token create(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException

Creates a single-use token that represents a bank account’s details. This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

Throws:

StripeException

create

public static Token create(TokenCreateParams params)
                    throws StripeException

Creates a single-use token that represents a bank account’s details. This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

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. This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

Throws:

StripeException

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

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 java.lang.String getClientIp()

IP address of the client that generated the token.

getCreated

public java.lang.Long getCreated()

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

getLivemode

public java.lang.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 java.lang.String getObject()

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

Equal to token.

getType

public java.lang.String getType()

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

getUsed

public java.lang.Boolean getUsed()

Whether this token has already been used (tokens can be used only 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 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.

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(java.lang.String clientIp)

IP address of the client that generated the token.

setCreated

public void setCreated(java.lang.Long created)

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

setId

public void setId(java.lang.String id)

Unique identifier for the object.

setLivemode

public void setLivemode(java.lang.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(java.lang.String object)

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

Equal to token.

setType

public void setType(java.lang.String type)

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

setUsed

public void setUsed(java.lang.Boolean used)

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId