com.stripe.model.issuing

Class Card

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.issuing.Card

All Implemented Interfaces:

HasId, MetadataStore<Card>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Card.AuthorizationControls
static class	Card.Shipping
static class	Card.SpendingLimit

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

ApiResource.RequestMethod, ApiResource.RequestType

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

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
static Card	create(CardCreateParams params) Creates an Issuing Card object.
static Card	create(CardCreateParams params, RequestOptions options) Creates an Issuing Card object.
static Card	create(java.util.Map<java.lang.String,java.lang.Object> params) Creates an Issuing Card object.
static Card	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Creates an Issuing Card object.
CardDetails	details() For virtual cards only.
CardDetails	details(CardDetailsParams params) For virtual cards only.
CardDetails	details(CardDetailsParams params, RequestOptions options) For virtual cards only.
CardDetails	details(java.util.Map<java.lang.String,java.lang.Object> params) For virtual cards only.
CardDetails	details(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) For virtual cards only.
boolean	equals(java.lang.Object o)
Card.AuthorizationControls	getAuthorizationControls()
java.lang.String	getBrand() The brand of the card.
Cardholder	getCardholder() The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object to which the card belongs.
java.lang.Long	getCreated() Time at which the object was created.
java.lang.String	getCurrency() Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
java.lang.Long	getExpMonth() The expiration month of the card.
java.lang.Long	getExpYear() The expiration year of the card.
java.lang.String	getId() Unique identifier for the object.
java.lang.String	getLast4() The last 4 digits of the card number.
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.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.String	getName() The name of the cardholder, printed on the card.
java.lang.String	getObject() String representing the object's type.
java.lang.String	getReplacementFor() Get id of expandable `replacementFor` object.
Card	getReplacementForObject() Get expanded `replacementFor`.
java.lang.String	getReplacementReason() Why the card that this card replaces (if any) needed to be replaced.
Card.Shipping	getShipping() Where and how the card will be shipped.
java.lang.String	getStatus() One of `active`, `inactive`, `canceled`, `lost`, `stolen`, or `pending`.
java.lang.String	getType() One of `virtual` or `physical`.
int	hashCode()
static CardCollection	list(CardListParams params) Returns a list of Issuing Card objects.
static CardCollection	list(CardListParams params, RequestOptions options) Returns a list of Issuing Card objects.
static CardCollection	list(java.util.Map<java.lang.String,java.lang.Object> params) Returns a list of Issuing Card objects.
static CardCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Returns a list of Issuing Card objects.
static Card	retrieve(java.lang.String card) Retrieves an Issuing Card object.
static Card	retrieve(java.lang.String card, CardRetrieveParams params, RequestOptions options) Retrieves an Issuing Card object.
static Card	retrieve(java.lang.String card, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrieves an Issuing Card object.
static Card	retrieve(java.lang.String card, RequestOptions options) Retrieves an Issuing Card object.
void	setAuthorizationControls(Card.AuthorizationControls authorizationControls)
void	setBrand(java.lang.String brand) The brand of the card.
void	setCardholder(Cardholder cardholder) The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object to which the card belongs.
void	setCreated(java.lang.Long created) Time at which the object was created.
void	setCurrency(java.lang.String currency) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
void	setExpMonth(java.lang.Long expMonth) The expiration month of the card.
void	setExpYear(java.lang.Long expYear) The expiration year of the card.
void	setId(java.lang.String id) Unique identifier for the object.
void	setLast4(java.lang.String last4) The last 4 digits of the card number.
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	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set of key-value pairs that you can attach to an object.
void	setName(java.lang.String name) The name of the cardholder, printed on the card.
void	setObject(java.lang.String object) String representing the object's type.
void	setReplacementFor(java.lang.String id)
void	setReplacementForObject(Card expandableObject)
void	setReplacementReason(java.lang.String replacementReason) Why the card that this card replaces (if any) needed to be replaced.
void	setShipping(Card.Shipping shipping) Where and how the card will be shipped.
void	setStatus(java.lang.String status) One of `active`, `inactive`, `canceled`, `lost`, `stolen`, or `pending`.
void	setType(java.lang.String type) One of `virtual` or `physical`.
Card	update(CardUpdateParams params) Updates the specified Issuing Card object by setting the values of the parameters passed.
Card	update(CardUpdateParams params, RequestOptions options) Updates the specified Issuing Card object by setting the values of the parameters passed.
Card	update(java.util.Map<java.lang.String,java.lang.Object> params) Updates the specified Issuing Card object by setting the values of the parameters passed.
Card	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Updates the specified Issuing Card object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, multipartRequest, 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

Card

public Card()

Method Detail

getReplacementFor

public java.lang.String getReplacementFor()

Get id of expandable `replacementFor` object.

setReplacementFor

public void setReplacementFor(java.lang.String id)

getReplacementForObject

public Card getReplacementForObject()

Get expanded `replacementFor`.

setReplacementForObject

public void setReplacementForObject(Card expandableObject)

list

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

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

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

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static CardCollection list(CardListParams params)
                           throws StripeException

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

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

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

create

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

Creates an Issuing Card object.

Throws:

StripeException

create

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

Creates an Issuing Card object.

Throws:

StripeException

create

public static Card create(CardCreateParams params)
                   throws StripeException

Creates an Issuing Card object.

Throws:

StripeException

create

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

Creates an Issuing Card object.

Throws:

StripeException

retrieve

public static Card retrieve(java.lang.String card)
                     throws StripeException

Retrieves an Issuing Card object.

Throws:

StripeException

retrieve

public static Card retrieve(java.lang.String card,
                            RequestOptions options)
                     throws StripeException

Retrieves an Issuing Card object.

Throws:

StripeException

retrieve

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

Retrieves an Issuing Card object.

Throws:

StripeException

retrieve

public static Card retrieve(java.lang.String card,
                            CardRetrieveParams params,
                            RequestOptions options)
                     throws StripeException

Retrieves an Issuing Card object.

Throws:

StripeException

update

public Card update(java.util.Map<java.lang.String,java.lang.Object> params)
            throws StripeException

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Specified by:

update in interface MetadataStore<Card>

Throws:

StripeException

update

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

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Specified by:

update in interface MetadataStore<Card>

Throws:

StripeException

update

public Card update(CardUpdateParams params)
            throws StripeException

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

update

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

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

details

public CardDetails details()
                    throws StripeException

For virtual cards only. Retrieves an Issuing Card_details object that contains the sensitive details of a virtual card.

Throws:

StripeException

details

public CardDetails details(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException

For virtual cards only. Retrieves an Issuing Card_details object that contains the sensitive details of a virtual card.

Throws:

StripeException

details

public CardDetails details(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException

For virtual cards only. Retrieves an Issuing Card_details object that contains the sensitive details of a virtual card.

Throws:

StripeException

details

public CardDetails details(CardDetailsParams params)
                    throws StripeException

For virtual cards only. Retrieves an Issuing Card_details object that contains the sensitive details of a virtual card.

Throws:

StripeException

details

public CardDetails details(CardDetailsParams params,
                           RequestOptions options)
                    throws StripeException

For virtual cards only. Retrieves an Issuing Card_details object that contains the sensitive details of a virtual card.

Throws:

StripeException

getAuthorizationControls

public Card.AuthorizationControls getAuthorizationControls()

getBrand

public java.lang.String getBrand()

The brand of the card.

getCardholder

public Cardholder getCardholder()

The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object to which the card belongs.

getCreated

public java.lang.Long getCreated()

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

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

getExpMonth

public java.lang.Long getExpMonth()

The expiration month of the card.

getExpYear

public java.lang.Long getExpYear()

The expiration year of the card.

getLast4

public java.lang.String getLast4()

The last 4 digits of the card number.

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.

getName

public java.lang.String getName()

The name of the cardholder, printed on the card.

getObject

public java.lang.String getObject()

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

getReplacementReason

public java.lang.String getReplacementReason()

Why the card that this card replaces (if any) needed to be replaced. One of `damage`, `expiration`, `loss`, or `theft`.

getShipping

public Card.Shipping getShipping()

Where and how the card will be shipped.

getStatus

public java.lang.String getStatus()

One of `active`, `inactive`, `canceled`, `lost`, `stolen`, or `pending`.

getType

public java.lang.String getType()

One of `virtual` or `physical`.

setAuthorizationControls

public void setAuthorizationControls(Card.AuthorizationControls authorizationControls)

setBrand

public void setBrand(java.lang.String brand)

The brand of the card.

setCardholder

public void setCardholder(Cardholder cardholder)

The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object to which the card belongs.

setCreated

public void setCreated(java.lang.Long created)

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

setCurrency

public void setCurrency(java.lang.String currency)

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

setExpMonth

public void setExpMonth(java.lang.Long expMonth)

The expiration month of the card.

setExpYear

public void setExpYear(java.lang.Long expYear)

The expiration year of the card.

setId

public void setId(java.lang.String id)

Unique identifier for the object.

setLast4

public void setLast4(java.lang.String last4)

The last 4 digits of the card number.

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.

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.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.

setName

public void setName(java.lang.String name)

The name of the cardholder, printed on the card.

setObject

public void setObject(java.lang.String object)

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

setReplacementReason

public void setReplacementReason(java.lang.String replacementReason)

Why the card that this card replaces (if any) needed to be replaced. One of `damage`, `expiration`, `loss`, or `theft`.

setShipping

public void setShipping(Card.Shipping shipping)

Where and how the card will be shipped.

setStatus

public void setStatus(java.lang.String status)

One of `active`, `inactive`, `canceled`, `lost`, `stolen`, or `pending`.

setType

public void setType(java.lang.String type)

One of `virtual` or `physical`.

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

getMetadata

public java.util.Map<java.lang.String,java.lang.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>