com.stripe.android.model

Class Card

java.lang.Object

StripeModel

com.stripe.android.model.Card

All Implemented Interfaces:

StripeParamsModel, StripePaymentSource

public final class Card
extends StripeModel
implements StripePaymentSource, StripeParamsModel

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 int	CVC_LENGTH_AMERICAN_EXPRESS
static int	CVC_LENGTH_COMMON
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

Method Summary

Modifier and Type	Method and Description
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	create(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.
boolean	equals(java.lang.Object obj)
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.
static int	getBrandIcon(java.lang.String brand)
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.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getName()
java.lang.String	getNumber()
int	hashCode()
Card.Builder	toBuilder()
java.util.Map<java.lang.String,java.lang.Object>	toParamMap()
PaymentMethodCreateParams.Card	toPaymentMethodParamsCard()
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 java.lang.Object

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

Field Detail

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

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

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

getBrandIcon

public static int getBrandIcon(java.lang.String brand)

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)

create

public static Card create(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

toPaymentMethodParamsCard

public PaymentMethodCreateParams.Card toPaymentMethodParamsCard()

toBuilder

public Card.Builder toBuilder()

Returns:

a Card.Builder populated with the fields of this Card instance

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

getCVC

public java.lang.String getCVC()

Returns:

the cvc for this card

getExpMonth

public java.lang.Integer getExpMonth()

Returns:

the expMonth for this card

getExpYear

public java.lang.Integer getExpYear()

Returns:

the expYear for this card

getName

public java.lang.String getName()

Returns:

the cardholder name for this card

getAddressLine1

public java.lang.String getAddressLine1()

Returns:

the addressLine1 of this card

getAddressLine2

public java.lang.String getAddressLine2()

Returns:

the addressLine2 of this card

getAddressCity

public java.lang.String getAddressCity()

Returns:

the addressCity for this card

getAddressZip

public java.lang.String getAddressZip()

Returns:

the addressZip of this card

getAddressState

public java.lang.String getAddressState()

Returns:

the addressState of this card

getAddressCountry

public java.lang.String getAddressCountry()

Returns:

the addressCountry of this card

getCurrency

public java.lang.String getCurrency()

Returns:

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

getMetadata

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

Returns:

the metadata of this card

getLast4

public java.lang.String getLast4()

Returns:

the last4 digits 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.

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

toParamMap

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

Specified by:

toParamMap in interface StripeParamsModel