Package com.stripe.param.issuing

Class CardholderCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.issuing.CardholderCreateParams

public class CardholderCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CardholderCreateParams.Billing
static class	CardholderCreateParams.Builder
static class	CardholderCreateParams.Company	State, county, province, or region.
static class	CardholderCreateParams.Individual	The entity's business ID number.
static class	CardholderCreateParams.SpendingControls	The front of an ID returned by a file upload with a purpose value of identity_document.
static class	CardholderCreateParams.Status
static class	CardholderCreateParams.Type

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

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static CardholderCreateParams.Builder	builder()
CardholderCreateParams.Billing	getBilling()	The cardholder's billing address.
CardholderCreateParams.Company	getCompany()	Additional information about a company cardholder.
java.lang.String	getEmail()	The cardholder's email address.
java.util.List<java.lang.String>	getExpand()	Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
CardholderCreateParams.Individual	getIndividual()	Additional information about an individual cardholder.
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	getPhoneNumber()	The cardholder's phone number.
CardholderCreateParams.SpendingControls	getSpendingControls()	Rules that control spending across this cardholder's cards.
CardholderCreateParams.Status	getStatus()	Specifies whether to permit authorizations on this cardholder's cards.
CardholderCreateParams.Type	getType()	One of individual or company.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static CardholderCreateParams.Builder builder()

getBilling

public CardholderCreateParams.Billing getBilling()

The cardholder's billing address.

getCompany

public CardholderCreateParams.Company getCompany()

Additional information about a company cardholder.

getEmail

public java.lang.String getEmail()

The cardholder's email address.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getIndividual

public CardholderCreateParams.Individual getIndividual()

Additional information about an individual cardholder.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

getName

public java.lang.String getName()

The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters.

getPhoneNumber

public java.lang.String getPhoneNumber()

The cardholder's phone number. This will be transformed to E.164 if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.

getSpendingControls

public CardholderCreateParams.SpendingControls getSpendingControls()

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

getStatus

public CardholderCreateParams.Status getStatus()

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

getType

public CardholderCreateParams.Type getType()

One of individual or company.