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>
,StripeObjectInterface
public class Cardholder extends ApiResource implements HasId, MetadataStore<Cardholder>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Cardholder.Billing
static class
Cardholder.Company
static class
Cardholder.Individual
static class
Cardholder.Requirements
Get expandedfront
.static class
Cardholder.SpendingControls
-
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 Cardholder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.Object other)
static Cardholder
create(CardholderCreateParams params)
Creates a new IssuingCardholder
object that can be issued cards.static Cardholder
create(CardholderCreateParams params, RequestOptions options)
Creates a new IssuingCardholder
object that can be issued cards.static Cardholder
create(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a new IssuingCardholder
object that can be issued cards.static Cardholder
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Creates a new IssuingCardholder
object that can be issued cards.boolean
equals(java.lang.Object o)
Cardholder.Billing
getBilling()
Cardholder.Company
getCompany()
Additional information about acompany
cardholder.java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getEmail()
The cardholder's email address.java.lang.String
getId()
Unique identifier for the object.Cardholder.Individual
getIndividual()
Additional information about anindividual
cardholder.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
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 cardholder's name.java.lang.String
getObject()
String representing the object's type.java.lang.String
getPhoneNumber()
The cardholder's phone number.Cardholder.Requirements
getRequirements()
Cardholder.SpendingControls
getSpendingControls()
Rules that control spending across this cardholder's cards.java.lang.String
getStatus()
Specifies whether to permit authorizations on this cardholder's cards.java.lang.String
getType()
One ofindividual
orcompany
.int
hashCode()
static CardholderCollection
list(CardholderListParams params)
Returns a list of IssuingCardholder
objects.static CardholderCollection
list(CardholderListParams params, RequestOptions options)
Returns a list of IssuingCardholder
objects.static CardholderCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of IssuingCardholder
objects.static CardholderCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of IssuingCardholder
objects.static Cardholder
retrieve(java.lang.String cardholder)
Retrieves an IssuingCardholder
object.static Cardholder
retrieve(java.lang.String cardholder, RequestOptions options)
Retrieves an IssuingCardholder
object.static Cardholder
retrieve(java.lang.String cardholder, CardholderRetrieveParams params, RequestOptions options)
Retrieves an IssuingCardholder
object.static Cardholder
retrieve(java.lang.String cardholder, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves an IssuingCardholder
object.void
setBilling(Cardholder.Billing billing)
void
setCompany(Cardholder.Company company)
Additional information about acompany
cardholder.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setEmail(java.lang.String email)
The cardholder's email address.void
setId(java.lang.String id)
Unique identifier for the object.void
setIndividual(Cardholder.Individual individual)
Additional information about anindividual
cardholder.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
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 cardholder's name.void
setObject(java.lang.String object)
String representing the object's type.void
setPhoneNumber(java.lang.String phoneNumber)
The cardholder's phone number.void
setRequirements(Cardholder.Requirements requirements)
void
setSpendingControls(Cardholder.SpendingControls spendingControls)
Rules that control spending across this cardholder's cards.void
setStatus(java.lang.String status)
Specifies whether to permit authorizations on this cardholder's cards.void
setType(java.lang.String type)
One ofindividual
orcompany
.Cardholder
update(CardholderUpdateParams params)
Updates the specified IssuingCardholder
object by setting the values of the parameters passed.Cardholder
update(CardholderUpdateParams params, RequestOptions options)
Updates the specified IssuingCardholder
object by setting the values of the parameters passed.Cardholder
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates the specified IssuingCardholder
object by setting the values of the parameters passed.Cardholder
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Updates the specified IssuingCardholder
object by setting the values of the parameters passed.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, 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
-
-
-
-
Method Detail
-
list
public static CardholderCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of IssuingCardholder
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(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of IssuingCardholder
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 IssuingCardholder
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 IssuingCardholder
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
create
public static Cardholder create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a new IssuingCardholder
object that can be issued cards.- Throws:
StripeException
-
create
public static Cardholder create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Creates a new IssuingCardholder
object that can be issued cards.- Throws:
StripeException
-
create
public static Cardholder create(CardholderCreateParams params) throws StripeException
Creates a new IssuingCardholder
object that can be issued cards.- Throws:
StripeException
-
create
public static Cardholder create(CardholderCreateParams params, RequestOptions options) throws StripeException
Creates a new IssuingCardholder
object that can be issued cards.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder) throws StripeException
Retrieves an IssuingCardholder
object.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder, RequestOptions options) throws StripeException
Retrieves an IssuingCardholder
object.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves an IssuingCardholder
object.- Throws:
StripeException
-
retrieve
public static Cardholder retrieve(java.lang.String cardholder, CardholderRetrieveParams params, RequestOptions options) throws StripeException
Retrieves an IssuingCardholder
object.- Throws:
StripeException
-
update
public Cardholder update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates the specified IssuingCardholder
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
update
in interfaceMetadataStore<Cardholder>
- Throws:
StripeException
-
update
public Cardholder update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates the specified IssuingCardholder
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
update
in interfaceMetadataStore<Cardholder>
- Throws:
StripeException
-
update
public Cardholder update(CardholderUpdateParams params) throws StripeException
Updates the specified IssuingCardholder
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 IssuingCardholder
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
getBilling
public Cardholder.Billing getBilling()
-
getCompany
public Cardholder.Company getCompany()
Additional information about acompany
cardholder.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getEmail
public java.lang.String getEmail()
The cardholder's email address.
-
getIndividual
public Cardholder.Individual getIndividual()
Additional information about anindividual
cardholder.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getName
public java.lang.String getName()
The cardholder's name. This will be printed on cards issued to them.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
issuing.cardholder
.
-
getPhoneNumber
public java.lang.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.
-
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 java.lang.String getStatus()
Specifies whether to permit authorizations on this cardholder's cards.One of
active
,blocked
, orinactive
.
-
getType
public java.lang.String getType()
One ofindividual
orcompany
.
-
setBilling
public void setBilling(Cardholder.Billing billing)
-
setCompany
public void setCompany(Cardholder.Company company)
Additional information about acompany
cardholder.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setEmail
public void setEmail(java.lang.String email)
The cardholder's email address.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setIndividual
public void setIndividual(Cardholder.Individual individual)
Additional information about anindividual
cardholder.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
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 cardholder's name. This will be printed on cards issued to them.
-
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
issuing.cardholder
.
-
setPhoneNumber
public void setPhoneNumber(java.lang.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.
-
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(java.lang.String status)
Specifies whether to permit authorizations on this cardholder's cards.One of
active
,blocked
, orinactive
.
-
setType
public void setType(java.lang.String type)
One ofindividual
orcompany
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
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 interfaceMetadataStore<Cardholder>
-
-