com.stripe.android.model

Class Card

java.lang.Object

com.stripe.android.model.StripeJsonModel

com.stripe.android.model.Card

All Implemented Interfaces:

StripePaymentSource

public class Card
extends StripeJsonModel
implements StripePaymentSource

A model object representing a Card in the Android SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Card.Builder Builder class for a Card model.
static interface	Card.CardBrand
static interface	Card.FundingType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AMERICAN_EXPRESS
static java.util.Map<java.lang.String,java.lang.Integer>	BRAND_RESOURCE_MAP
static int	CVC_LENGTH_AMERICAN_EXPRESS
static int	CVC_LENGTH_COMMON
static java.lang.String	DINERS_CLUB
static java.lang.String	DISCOVER
static java.lang.String	FUNDING_CREDIT
static java.lang.String	FUNDING_DEBIT
static java.lang.String	FUNDING_PREPAID
static java.lang.String	FUNDING_UNKNOWN
static java.lang.String	JCB
static java.lang.String	MASTERCARD
static int	MAX_LENGTH_AMERICAN_EXPRESS
static int	MAX_LENGTH_DINERS_CLUB
static int	MAX_LENGTH_STANDARD
static java.lang.String[]	PREFIXES_AMERICAN_EXPRESS
static java.lang.String[]	PREFIXES_DINERS_CLUB
static java.lang.String[]	PREFIXES_DISCOVER
static java.lang.String[]	PREFIXES_JCB
static java.lang.String[]	PREFIXES_MASTERCARD
static java.lang.String[]	PREFIXES_UNIONPAY
static java.lang.String[]	PREFIXES_VISA
static java.lang.String	UNIONPAY
static java.lang.String	UNKNOWN
static java.lang.String	VISA

Constructor Summary

Constructors

Constructor and Description
Card(java.lang.String number, java.lang.Integer expMonth, java.lang.Integer expYear, java.lang.String cvc) Convenience constructor for a Card object with a minimum number of inputs.
Card(java.lang.String number, java.lang.Integer expMonth, java.lang.Integer expYear, java.lang.String cvc, java.lang.String name, java.lang.String addressLine1, java.lang.String addressLine2, java.lang.String addressCity, java.lang.String addressState, java.lang.String addressZip, java.lang.String addressCountry, java.lang.String currency) Convenience constructor with address and currency.
Card(java.lang.String number, java.lang.Integer expMonth, java.lang.Integer expYear, java.lang.String cvc, java.lang.String name, java.lang.String addressLine1, java.lang.String addressLine2, java.lang.String addressCity, java.lang.String addressState, java.lang.String addressZip, java.lang.String addressCountry, java.lang.String brand, java.lang.String last4, java.lang.String fingerprint, java.lang.String funding, java.lang.String country, java.lang.String currency, java.lang.String id) Card constructor with all available fields.

Method Summary

Modifier and Type	Method and Description
Card	addLoggingToken(java.lang.String loggingToken) Add a logging token to this Card object.
static java.lang.String	asCardBrand(java.lang.String possibleCardType) Converts an unchecked String value to a Card.CardBrand or null.
static java.lang.String	asFundingType(java.lang.String possibleFundingType) Converts an unchecked String value to a Card.FundingType or null.
static Card	fromJson(org.json.JSONObject jsonObject)
static Card	fromString(java.lang.String jsonString) Create a Card object from a raw JSON string.
java.lang.String	getAddressCity()
java.lang.String	getAddressCountry()
java.lang.String	getAddressLine1()
java.lang.String	getAddressLine1Check()
java.lang.String	getAddressLine2()
java.lang.String	getAddressState()
java.lang.String	getAddressZip()
java.lang.String	getAddressZipCheck()
java.lang.String	getBrand() Gets the brand of this card.
java.lang.String	getCountry()
java.lang.String	getCurrency()
java.lang.String	getCustomerId()
java.lang.String	getCVC()
java.lang.String	getCvcCheck()
java.lang.Integer	getExpMonth()
java.lang.Integer	getExpYear()
java.lang.String	getFingerprint()
java.lang.String	getFunding()
java.lang.String	getId()
java.lang.String	getLast4()
java.util.List<java.lang.String>	getLoggingTokens()
java.lang.String	getName()
java.lang.String	getNumber()
java.lang.String	getType() Deprecated.
void	setAddressCity(java.lang.String addressCity)
void	setAddressCountry(java.lang.String addressCountry)
void	setAddressLine1(java.lang.String addressLine1)
void	setAddressLine2(java.lang.String addressLine2)
void	setAddressState(java.lang.String addressState)
void	setAddressZip(java.lang.String addressZip)
void	setCurrency(java.lang.String currency)
void	setCVC(java.lang.String cvc) Deprecated.
void	setExpMonth(java.lang.Integer expMonth) Deprecated.
void	setExpYear(java.lang.Integer expYear) Deprecated.
void	setName(java.lang.String name)
void	setNumber(java.lang.String number) Deprecated.
org.json.JSONObject	toJson()
java.util.Map<java.lang.String,java.lang.Object>	toMap()
boolean	validateCard() Checks whether this represents a valid card.
boolean	validateCVC() Checks whether or not the cvc field is valid.
boolean	validateExpiryDate() Checks whether or not the expMonth and expYear fields represent a valid expiry date.
boolean	validateExpMonth() Checks whether or not the expMonth field is valid.
boolean	validateNumber() Checks whether or not the number field is valid.

Methods inherited from class com.stripe.android.model.StripeJsonModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

AMERICAN_EXPRESS

public static final java.lang.String AMERICAN_EXPRESS

See Also:

Constant Field Values

DISCOVER

public static final java.lang.String DISCOVER

See Also:

Constant Field Values

JCB

public static final java.lang.String JCB

See Also:

Constant Field Values

DINERS_CLUB

public static final java.lang.String DINERS_CLUB

See Also:

Constant Field Values

VISA

public static final java.lang.String VISA

See Also:

Constant Field Values

MASTERCARD

public static final java.lang.String MASTERCARD

See Also:

Constant Field Values

UNIONPAY

public static final java.lang.String UNIONPAY

See Also:

Constant Field Values

UNKNOWN

public static final java.lang.String UNKNOWN

See Also:

Constant Field Values

CVC_LENGTH_AMERICAN_EXPRESS

public static final int CVC_LENGTH_AMERICAN_EXPRESS

See Also:

Constant Field Values

CVC_LENGTH_COMMON

public static final int CVC_LENGTH_COMMON

See Also:

Constant Field Values

FUNDING_CREDIT

public static final java.lang.String FUNDING_CREDIT

See Also:

Constant Field Values

FUNDING_DEBIT

public static final java.lang.String FUNDING_DEBIT

See Also:

Constant Field Values

FUNDING_PREPAID

public static final java.lang.String FUNDING_PREPAID

See Also:

Constant Field Values

FUNDING_UNKNOWN

public static final java.lang.String FUNDING_UNKNOWN

See Also:

Constant Field Values

BRAND_RESOURCE_MAP

public static final java.util.Map<java.lang.String,java.lang.Integer> BRAND_RESOURCE_MAP

PREFIXES_AMERICAN_EXPRESS

public static final java.lang.String[] PREFIXES_AMERICAN_EXPRESS

PREFIXES_DISCOVER

public static final java.lang.String[] PREFIXES_DISCOVER

PREFIXES_JCB

public static final java.lang.String[] PREFIXES_JCB

PREFIXES_DINERS_CLUB

public static final java.lang.String[] PREFIXES_DINERS_CLUB

PREFIXES_VISA

public static final java.lang.String[] PREFIXES_VISA

PREFIXES_MASTERCARD

public static final java.lang.String[] PREFIXES_MASTERCARD

PREFIXES_UNIONPAY

public static final java.lang.String[] PREFIXES_UNIONPAY

MAX_LENGTH_STANDARD

public static final int MAX_LENGTH_STANDARD

See Also:

Constant Field Values

MAX_LENGTH_AMERICAN_EXPRESS

public static final int MAX_LENGTH_AMERICAN_EXPRESS

See Also:

Constant Field Values

MAX_LENGTH_DINERS_CLUB

public static final int MAX_LENGTH_DINERS_CLUB

See Also:

Constant Field Values

Constructor Detail

Card

public Card(java.lang.String number,
            java.lang.Integer expMonth,
            java.lang.Integer expYear,
            java.lang.String cvc,
            java.lang.String name,
            java.lang.String addressLine1,
            java.lang.String addressLine2,
            java.lang.String addressCity,
            java.lang.String addressState,
            java.lang.String addressZip,
            java.lang.String addressCountry,
            java.lang.String brand,
            java.lang.String last4,
            java.lang.String fingerprint,
            java.lang.String funding,
            java.lang.String country,
            java.lang.String currency,
            java.lang.String id)

Card constructor with all available fields.

Parameters:

number - the credit card number

expMonth - the expiry month

expYear - the expiry year

cvc - the CVC number

name - the card name

addressLine1 - first line of the billing address

addressLine2 - second line of the billing address

addressCity - city of the billing address

addressState - state of the billing address

addressZip - zip code of the billing address

addressCountry - country for the billing address

brand - brand of this card

last4 - last 4 digits of the card

fingerprint - the card fingerprint

funding - the funding type of the card

country - ISO country code of the card itself

currency - currency used by the card

id - the cardId

Card

public Card(java.lang.String number,
            java.lang.Integer expMonth,
            java.lang.Integer expYear,
            java.lang.String cvc,
            java.lang.String name,
            java.lang.String addressLine1,
            java.lang.String addressLine2,
            java.lang.String addressCity,
            java.lang.String addressState,
            java.lang.String addressZip,
            java.lang.String addressCountry,
            java.lang.String currency)

Convenience constructor with address and currency.

Parameters:

number - the card number

expMonth - the expiry month

expYear - the expiry year

cvc - the CVC code

name - the cardholder name

addressLine1 - the first line of the billing address

addressLine2 - the second line of the billing address

addressCity - the city of the billing address

addressState - the state of the billing address

addressZip - the zip code of the billing address

addressCountry - the country of the billing address

currency - the currency of the card

Card

public Card(java.lang.String number,
            java.lang.Integer expMonth,
            java.lang.Integer expYear,
            java.lang.String cvc)

Convenience constructor for a Card object with a minimum number of inputs.

Parameters:

number - the card number

expMonth - the expiry month

expYear - the expiry year

cvc - the CVC code

Method Detail

asCardBrand

public static java.lang.String asCardBrand(java.lang.String possibleCardType)

Converts an unchecked String value to a Card.CardBrand or null.

Parameters:

possibleCardType - a String that might match a Card.CardBrand or be empty.

Returns:

null if the input is blank, else the appropriate Card.CardBrand.

asFundingType

public static java.lang.String asFundingType(java.lang.String possibleFundingType)

Converts an unchecked String value to a Card.FundingType or null.

Parameters:

possibleFundingType - a String that might match a Card.FundingType or be empty

Returns:

null if the input is blank, else the appropriate Card.FundingType

fromString

public static Card fromString(java.lang.String jsonString)

Create a Card object from a raw JSON string.

Parameters:

jsonString - the JSON string representing the potential Card

Returns:

A Card if one can be made from the JSON, or null if one cannot be made or the JSON is invalid.

fromJson

public static Card fromJson(org.json.JSONObject jsonObject)

validateCard

public boolean validateCard()

Checks whether this represents a valid card.

Returns:

true if valid, false otherwise.

validateNumber

public boolean validateNumber()

Checks whether or not the number field is valid.

Returns:

true if valid, false otherwise.

validateExpiryDate

public boolean validateExpiryDate()

Checks whether or not the expMonth and expYear fields represent a valid expiry date.

Returns:

true if valid, false otherwise

validateCVC

public boolean validateCVC()

Checks whether or not the cvc field is valid.

Returns:

true if valid, false otherwise

validateExpMonth

public boolean validateExpMonth()

Checks whether or not the expMonth field is valid.

Returns:

true if valid, false otherwise.

getNumber

public java.lang.String getNumber()

Returns:

the number of this card

getLoggingTokens

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

Returns:

the List of logging tokens associated with this Card object

addLoggingToken

public Card addLoggingToken(java.lang.String loggingToken)

Add a logging token to this Card object.

Parameters:

loggingToken - a token to be logged with this card

Returns:

this, for chaining purposes

setNumber

@Deprecated
public void setNumber(java.lang.String number)

Deprecated.

Setter for the card number. Note that mutating the number of this card object invalidates the brand and last4.

Parameters:

number - the new number

getCVC

public java.lang.String getCVC()

Returns:

the cvc for this card

setCVC

@Deprecated
public void setCVC(java.lang.String cvc)

Deprecated.

Parameters:

cvc - the new cvc code for this card

getExpMonth

public java.lang.Integer getExpMonth()

Returns:

the expMonth for this card

setExpMonth

@Deprecated
public void setExpMonth(java.lang.Integer expMonth)

Deprecated.

Parameters:

expMonth - sets the expMonth for this card

getExpYear

public java.lang.Integer getExpYear()

Returns:

the expYear for this card

setExpYear

@Deprecated
public void setExpYear(java.lang.Integer expYear)

Deprecated.

Parameters:

expYear - sets the expYear for this card

getName

public java.lang.String getName()

Returns:

the cardholder name for this card

setName

public void setName(java.lang.String name)

Parameters:

name - sets the cardholder name for this card

getAddressLine1

public java.lang.String getAddressLine1()

Returns:

the addressLine1 of this card

setAddressLine1

public void setAddressLine1(java.lang.String addressLine1)

Parameters:

addressLine1 - sets the addressLine1 for this card

getAddressLine2

public java.lang.String getAddressLine2()

Returns:

the addressLine2 of this card

setAddressLine2

public void setAddressLine2(java.lang.String addressLine2)

Parameters:

addressLine2 - sets the addressLine2 for this card

getAddressCity

public java.lang.String getAddressCity()

Returns:

the addressCity for this card

setAddressCity

public void setAddressCity(java.lang.String addressCity)

Parameters:

addressCity - sets the addressCity for this card

getAddressZip

public java.lang.String getAddressZip()

Returns:

the addressZip of this card

setAddressZip

public void setAddressZip(java.lang.String addressZip)

Parameters:

addressZip - sets the addressZip for this card

getAddressState

public java.lang.String getAddressState()

Returns:

the addressState of this card

setAddressState

public void setAddressState(java.lang.String addressState)

Parameters:

addressState - sets the addressState for this card

getAddressCountry

public java.lang.String getAddressCountry()

Returns:

the addressCountry of this card

setAddressCountry

public void setAddressCountry(java.lang.String addressCountry)

Parameters:

addressCountry - sets the addressCountry for this card

getCurrency

public java.lang.String getCurrency()

Returns:

the currency of this card. Only supported for Managed accounts.

setCurrency

public void setCurrency(java.lang.String currency)

Parameters:

currency - sets the currency of this card. Only supported for Managed accounts.

getLast4

public java.lang.String getLast4()

Returns:

the last4 digits of this card. Sets the value based on the number if it has not already been set.

getType

@Deprecated
public java.lang.String getType()

Deprecated.

Gets the brand of this card, changed from the "type" field. Use getBrand() instead.

Returns:

the brand of this card

getBrand

public java.lang.String getBrand()

Gets the brand of this card. Updates the value if none has yet been set, or if the number has been changed.

Returns:

the brand of this card

getFingerprint

public java.lang.String getFingerprint()

Returns:

the fingerprint of this card

getFunding

public java.lang.String getFunding()

Returns:

the funding type of this card

getCountry

public java.lang.String getCountry()

Returns:

the country of this card

getId

public java.lang.String getId()

Specified by:

getId in interface StripePaymentSource

Returns:

the id of this card

getAddressLine1Check

public java.lang.String getAddressLine1Check()

Returns:

If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

getAddressZipCheck

public java.lang.String getAddressZipCheck()

Returns:

If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

getCustomerId

public java.lang.String getCustomerId()

Returns:

The ID of the customer that this card belongs to.

getCvcCheck

public java.lang.String getCvcCheck()

Returns:

If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.

toJson

public org.json.JSONObject toJson()

Specified by:

toJson in class StripeJsonModel

toMap

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

Specified by:

toMap in class StripeJsonModel