Package com.stripe.model.giftcards

Class Card

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.giftcards.Card

All Implemented Interfaces:

HasId, MetadataStore<Card>, StripeObjectInterface

public class Card
extends ApiResource
implements HasId, MetadataStore<Card>

A gift card represents a single gift card owned by a customer, including the remaining balance, gift card code, and whether or not it is active.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Card.CreatedBy

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	Description
Card()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Card	create(CardCreateParams params)	Creates a new gift card object.
static Card	create(CardCreateParams params, RequestOptions options)	Creates a new gift card object.
static Card	create(Map<String,Object> params)	Creates a new gift card object.
static Card	create(Map<String,Object> params, RequestOptions options)	Creates a new gift card object.
boolean	equals(Object o)
Boolean	getActive()	Whether this gift card can be used or not.
Long	getAmountAvailable()	The amount of funds available for new transactions.
Long	getAmountHeld()	The amount of funds marked as held.
String	getCode()	Code used to redeem this gift card.
Long	getCreated()	Time at which the object was created.
Card.CreatedBy	getCreatedBy()	The related Stripe objects that created this gift card.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getId()	Unique identifier for the object.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
TransactionCollection	getTransactions()	Transactions on this gift card.
int	hashCode()
static CardCollection	list(CardListParams params)	List gift cards for an account.
static CardCollection	list(CardListParams params, RequestOptions options)	List gift cards for an account.
static CardCollection	list(Map<String,Object> params)	List gift cards for an account.
static CardCollection	list(Map<String,Object> params, RequestOptions options)	List gift cards for an account.
static Card	retrieve(String id)	Retrieve a gift card by id.
static Card	retrieve(String id, RequestOptions options)	Retrieve a gift card by id.
static Card	retrieve(String id, CardRetrieveParams params, RequestOptions options)	Retrieve a gift card by id.
static Card	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieve a gift card by id.
void	setActive(Boolean active)	Whether this gift card can be used or not.
void	setAmountAvailable(Long amountAvailable)	The amount of funds available for new transactions.
void	setAmountHeld(Long amountHeld)	The amount of funds marked as held.
void	setCode(String code)	Code used to redeem this gift card.
void	setCreated(Long created)	Time at which the object was created.
void	setCreatedBy(Card.CreatedBy createdBy)	The related Stripe objects that created this gift card.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setId(String id)	Unique identifier for the object.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setTransactions(TransactionCollection transactions)	Transactions on this gift card.
Card	update(CardUpdateParams params)	Update a gift card.
Card	update(CardUpdateParams params, RequestOptions options)	Update a gift card.
Card	update(Map<String,Object> params)	Update a gift card.
Card	update(Map<String,Object> params, RequestOptions options)	Update a gift card.
static Card	validate(CardValidateParams params)	Validates a gift card code, returning the matching gift card object if it exists.
static Card	validate(CardValidateParams params, RequestOptions options)	Validates a gift card code, returning the matching gift card object if it exists.
static Card	validate(Map<String,Object> params)	Validates a gift card code, returning the matching gift card object if it exists.
static Card	validate(Map<String,Object> params, RequestOptions options)	Validates a gift card code, returning the matching gift card object if it exists.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, 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 Details

Card

public Card()

Method Details

create

public static Card create(Map<String,Object> params)
                   throws StripeException

Creates a new gift card object.

Throws:

StripeException

create

public static Card create(Map<String,Object> params,
 RequestOptions options)
                   throws StripeException

Creates a new gift card object.

Throws:

StripeException

create

public static Card create(CardCreateParams params)
                   throws StripeException

Creates a new gift card object.

Throws:

StripeException

create

public static Card create(CardCreateParams params,
 RequestOptions options)
                   throws StripeException

Creates a new gift card object.

Throws:

StripeException

list

public static CardCollection list(Map<String,Object> params)
                           throws StripeException

List gift cards for an account.

Throws:

StripeException

list

public static CardCollection list(Map<String,Object> params,
 RequestOptions options)
                           throws StripeException

List gift cards for an account.

Throws:

StripeException

list

public static CardCollection list(CardListParams params)
                           throws StripeException

List gift cards for an account.

Throws:

StripeException

list

public static CardCollection list(CardListParams params,
 RequestOptions options)
                           throws StripeException

List gift cards for an account.

Throws:

StripeException

retrieve

public static Card retrieve(String id)
                     throws StripeException

Retrieve a gift card by id.

Throws:

StripeException

retrieve

public static Card retrieve(String id,
 RequestOptions options)
                     throws StripeException

Retrieve a gift card by id.

Throws:

StripeException

retrieve

public static Card retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Retrieve a gift card by id.

Throws:

StripeException

retrieve

public static Card retrieve(String id,
 CardRetrieveParams params,
 RequestOptions options)
                     throws StripeException

Retrieve a gift card by id.

Throws:

StripeException

update

public Card update(Map<String,Object> params)
            throws StripeException

Update a gift card.

Specified by:

update in interface MetadataStore<Card>

Throws:

StripeException

update

public Card update(Map<String,Object> params,
 RequestOptions options)
            throws StripeException

Update a gift card.

Specified by:

update in interface MetadataStore<Card>

Throws:

StripeException

update

public Card update(CardUpdateParams params)
            throws StripeException

Update a gift card.

Throws:

StripeException

update

public Card update(CardUpdateParams params,
 RequestOptions options)
            throws StripeException

Update a gift card.

Throws:

StripeException

validate

public static Card validate(Map<String,Object> params)
                     throws StripeException

Validates a gift card code, returning the matching gift card object if it exists.

Throws:

StripeException

validate

public static Card validate(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Validates a gift card code, returning the matching gift card object if it exists.

Throws:

StripeException

validate

public static Card validate(CardValidateParams params)
                     throws StripeException

Validates a gift card code, returning the matching gift card object if it exists.

Throws:

StripeException

validate

public static Card validate(CardValidateParams params,
 RequestOptions options)
                     throws StripeException

Validates a gift card code, returning the matching gift card object if it exists.

Throws:

StripeException

getActive

public Boolean getActive()

Whether this gift card can be used or not.

getAmountAvailable

public Long getAmountAvailable()

The amount of funds available for new transactions.

getAmountHeld

public Long getAmountHeld()

The amount of funds marked as held.

getCode

public String getCode()

Code used to redeem this gift card.

getCreated

public Long getCreated()

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

getCreatedBy

public Card.CreatedBy getCreatedBy()

The related Stripe objects that created this gift card.

getCurrency

public String getCurrency()

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

getObject

public String getObject()

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

Equal to gift_cards.card.

getTransactions

public TransactionCollection getTransactions()

Transactions on this gift card.

setActive

public void setActive(Boolean active)

Whether this gift card can be used or not.

setAmountAvailable

public void setAmountAvailable(Long amountAvailable)

The amount of funds available for new transactions.

setAmountHeld

public void setAmountHeld(Long amountHeld)

The amount of funds marked as held.

setCode

public void setCode(String code)

Code used to redeem this gift card.

setCreated

public void setCreated(Long created)

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

setCreatedBy

public void setCreatedBy(Card.CreatedBy createdBy)

The related Stripe objects that created this gift card.

setCurrency

public void setCurrency(String currency)

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

setId

public void setId(String id)

Unique identifier for the object.

setMetadata

public void setMetadata(Map<String,String> metadata)

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.

setObject

public void setObject(String object)

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

Equal to gift_cards.card.

setTransactions

public void setTransactions(TransactionCollection transactions)

Transactions on this gift card.

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

getMetadata

public Map<String,String> getMetadata()

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.

Specified by:

getMetadata in interface MetadataStore<Card>