Package com.stripe.model.issuing

Class Cardholder

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.issuing.Cardholder

All Implemented Interfaces:

HasId, MetadataStore<Cardholder>, StripeActiveObject, StripeObjectInterface

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

An Issuing Cardholder object represents an individual or business entity who is issued cards.

Related guide: How to create a cardholder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Cardholder.Billing	For more details about Billing, please refer to the API Reference.
static class	Cardholder.Company	For more details about Company, please refer to the API Reference.
static class	Cardholder.Individual	For more details about Individual, please refer to the API Reference.
static class	Cardholder.Requirements	For more details about Requirements, please refer to the API Reference.
static class	Cardholder.SpendingControls	For more details about SpendingControls, please refer to the API Reference.

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

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Cardholder()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Cardholder	create(CardholderCreateParams params)	Creates a new Issuing Cardholder object that can be issued cards.
static Cardholder	create(CardholderCreateParams params, RequestOptions options)	Creates a new Issuing Cardholder object that can be issued cards.
static Cardholder	create(Map<String,Object> params)	Creates a new Issuing Cardholder object that can be issued cards.
static Cardholder	create(Map<String,Object> params, RequestOptions options)	Creates a new Issuing Cardholder object that can be issued cards.
boolean	equals(Object o)
Cardholder.Billing	getBilling()
Cardholder.Company	getCompany()	Additional information about a company cardholder.
Long	getCreated()	Time at which the object was created.
String	getEmail()	The cardholder's email address.
String	getId()	Unique identifier for the object.
Cardholder.Individual	getIndividual()	Additional information about an individual cardholder.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	The cardholder's name.
String	getObject()	String representing the object's type.
String	getPhoneNumber()	The cardholder's phone number.
List<String>	getPreferredLocales()	The cardholder’s preferred locales (languages), ordered by preference.
Cardholder.Requirements	getRequirements()
Cardholder.SpendingControls	getSpendingControls()	Rules that control spending across this cardholder's cards.
String	getStatus()	Specifies whether to permit authorizations on this cardholder's cards.
String	getType()	One of individual or company.
int	hashCode()
static CardholderCollection	list(CardholderListParams params)	Returns a list of Issuing Cardholder objects.
static CardholderCollection	list(CardholderListParams params, RequestOptions options)	Returns a list of Issuing Cardholder objects.
static CardholderCollection	list(Map<String,Object> params)	Returns a list of Issuing Cardholder objects.
static CardholderCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of Issuing Cardholder objects.
static Cardholder	retrieve(String cardholder)	Retrieves an Issuing Cardholder object.
static Cardholder	retrieve(String cardholder, RequestOptions options)	Retrieves an Issuing Cardholder object.
static Cardholder	retrieve(String cardholder, CardholderRetrieveParams params, RequestOptions options)	Retrieves an Issuing Cardholder object.
static Cardholder	retrieve(String cardholder, Map<String,Object> params, RequestOptions options)	Retrieves an Issuing Cardholder object.
void	setBilling(Cardholder.Billing billing)
void	setCompany(Cardholder.Company company)	Additional information about a company cardholder.
void	setCreated(Long created)	Time at which the object was created.
void	setEmail(String email)	The cardholder's email address.
void	setId(String id)	Unique identifier for the object.
void	setIndividual(Cardholder.Individual individual)	Additional information about an individual cardholder.
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.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	The cardholder's name.
void	setObject(String object)	String representing the object's type.
void	setPhoneNumber(String phoneNumber)	The cardholder's phone number.
void	setPreferredLocales(List<String> preferredLocales)	The cardholder’s preferred locales (languages), ordered by preference.
void	setRequirements(Cardholder.Requirements requirements)
void	setResponseGetter(StripeResponseGetter responseGetter)	Interval (or event) to which the amount applies.
void	setSpendingControls(Cardholder.SpendingControls spendingControls)	Rules that control spending across this cardholder's cards.
void	setStatus(String status)	Specifies whether to permit authorizations on this cardholder's cards.
void	setType(String type)	One of individual or company.
Cardholder	update(CardholderUpdateParams params)	Updates the specified Issuing Cardholder object by setting the values of the parameters passed.
Cardholder	update(CardholderUpdateParams params, RequestOptions options)	Updates the specified Issuing Cardholder object by setting the values of the parameters passed.
Cardholder	update(Map<String,Object> params)	Updates the specified Issuing Cardholder object by setting the values of the parameters passed.
Cardholder	update(Map<String,Object> params, RequestOptions options)	Updates the specified Issuing Cardholder object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Cardholder

public Cardholder()

Method Details

create

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

Creates a new Issuing Cardholder object that can be issued cards.

Throws:

StripeException

create

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

Creates a new Issuing Cardholder object that can be issued cards.

Throws:

StripeException

create

public static Cardholder create(CardholderCreateParams params)
                         throws StripeException

Creates a new Issuing Cardholder object that can be issued cards.

Throws:

StripeException

create

public static Cardholder create(CardholderCreateParams params,
 RequestOptions options)
                         throws StripeException

Creates a new Issuing Cardholder object that can be issued cards.

Throws:

StripeException

list

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

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

Throws:

StripeException

list

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

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

Throws:

StripeException

list

public static CardholderCollection list(CardholderListParams params)
                                 throws StripeException

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

Throws:

StripeException

list

public static CardholderCollection list(CardholderListParams params,
 RequestOptions options)
                                 throws StripeException

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

Throws:

StripeException

retrieve

public static Cardholder retrieve(String cardholder)
                           throws StripeException

Retrieves an Issuing Cardholder object.

Throws:

StripeException

retrieve

public static Cardholder retrieve(String cardholder,
 RequestOptions options)
                           throws StripeException

Retrieves an Issuing Cardholder object.

Throws:

StripeException

retrieve

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

Retrieves an Issuing Cardholder object.

Throws:

StripeException

retrieve

public static Cardholder retrieve(String cardholder,
 CardholderRetrieveParams params,
 RequestOptions options)
                           throws StripeException

Retrieves an Issuing Cardholder object.

Throws:

StripeException

update

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

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

Specified by:

update in interface MetadataStore<Cardholder>

Throws:

StripeException

update

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

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

Specified by:

update in interface MetadataStore<Cardholder>

Throws:

StripeException

update

public Cardholder update(CardholderUpdateParams params)
                  throws StripeException

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

Throws:

StripeException

update

public Cardholder update(CardholderUpdateParams params,
 RequestOptions options)
                  throws StripeException

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

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Interval (or event) to which the amount applies.

One of all_time, daily, monthly, per_authorization, weekly, or yearly.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getBilling

public Cardholder.Billing getBilling()

getCompany

public Cardholder.Company getCompany()

Additional information about a company cardholder.

getCreated

public Long getCreated()

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

getEmail

public String getEmail()

The cardholder's email address.

getIndividual

public Cardholder.Individual getIndividual()

Additional information about an individual cardholder.

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.

getName

public String getName()

The cardholder's name. This will be printed on cards issued to them.

getObject

public String getObject()

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

Equal to issuing.cardholder.

getPhoneNumber

public String getPhoneNumber()

The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.

getPreferredLocales

public List<String> getPreferredLocales()

The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.

getRequirements

public Cardholder.Requirements getRequirements()

getSpendingControls

public Cardholder.SpendingControls getSpendingControls()

Rules that control spending across this cardholder's cards. Refer to our documentation for more details.

getStatus

public String getStatus()

Specifies whether to permit authorizations on this cardholder's cards.

One of active, blocked, or inactive.

getType

public String getType()

One of individual or company. See Choose a cardholder type for more details.

setBilling

public void setBilling(Cardholder.Billing billing)

setCompany

public void setCompany(Cardholder.Company company)

Additional information about a company cardholder.

setCreated

public void setCreated(Long created)

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

setEmail

public void setEmail(String email)

The cardholder's email address.

setId

public void setId(String id)

Unique identifier for the object.

setIndividual

public void setIndividual(Cardholder.Individual individual)

Additional information about an individual cardholder.

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.

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.

setName

public void setName(String name)

The cardholder's name. This will be printed on cards issued to them.

setObject

public void setObject(String object)

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

Equal to issuing.cardholder.

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.

setPreferredLocales

public void setPreferredLocales(List<String> preferredLocales)

The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.

setRequirements

public void setRequirements(Cardholder.Requirements requirements)

setSpendingControls

public void setSpendingControls(Cardholder.SpendingControls spendingControls)

Rules that control spending across this cardholder's cards. Refer to our documentation for more details.

setStatus

public void setStatus(String status)

Specifies whether to permit authorizations on this cardholder's cards.

One of active, blocked, or inactive.

setType

public void setType(String type)

One of individual or company. See Choose a cardholder type for more details.

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