com.paypal.api.payments

Class CreditCard

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.CreditCard

public class CreditCard
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
CreditCard() Default Constructor
CreditCard(java.lang.String number, java.lang.String type, int expireMonth, int expireYear) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
CreditCard	create(APIContext apiContext) Creates a new Credit Card Resource (aka Tokenize).
CreditCard	create(java.lang.String accessToken) Deprecated. Please use create(APIContext) instead.
void	delete(APIContext apiContext) Delete the Credit Card resource for the given identifier.
void	delete(java.lang.String accessToken) Deprecated. Please use delete(APIContext) instead.
boolean	equals(java.lang.Object o)
static CreditCard	get(APIContext apiContext, java.lang.String creditCardId) Obtain the Credit Card resource for the given identifier.
static CreditCard	get(java.lang.String accessToken, java.lang.String creditCardId) Deprecated. Please use get(APIContext, String) instead.
Address	getBillingAddress() Billing Address associated with this card.
int	getCvv2() Deprecated. Please use getCvv2String() instead. Getter for cvv2 Returns -1 if cvv2 is null. Not autogenerating using lombok as it includes logic to return -1 on null.
java.lang.String	getCvv2String() Returns the cvv2
int	getExpireMonth() Expiration month with no leading zero.
int	getExpireYear() 4-digit expiration year.
java.lang.String	getExternalCustomerId() A unique identifier of the customer to whom this bank account belongs.
java.lang.String	getFirstName() Cardholder's first name.
java.lang.String	getId() ID of the credit card.
java.lang.String	getLastName() Cardholder's last name.
java.util.List<Links>	getLinks()
java.lang.String	getNumber() Credit card number.
java.lang.String	getPayerId() Payer ID
java.lang.String	getState() State of the credit card funding instrument.
java.lang.String	getType() Credit card type.
java.lang.String	getValidUntil() Funding instrument expiration date.
int	hashCode()
static CreditCardHistory	list(APIContext apiContext) Retrieves a list of Credit Card resources.
static CreditCardHistory	list(APIContext apiContext, java.util.Map<java.lang.String,java.lang.String> containerMap) Retrieves a list of Credit Card resources.
static CreditCardHistory	list(java.lang.String accessToken) Deprecated. Please use list(APIContext, Map) instead.
static CreditCardHistory	list(java.lang.String accessToken, java.util.Map<java.lang.String,java.lang.String> containerMap) Deprecated. Please use list(APIContext, Map) instead.
CreditCard	setBillingAddress(Address billingAddress) Billing Address associated with this card.
CreditCard	setCvv2(java.lang.Integer cvv2) Deprecated. The cvv2 needs to be a string, as any cvv2 starting with 0 is sent invalid to servers. Please use setCvv2(String) instead.
CreditCard	setCvv2(java.lang.String cvv2)
CreditCard	setExpireMonth(int expireMonth) Expiration month with no leading zero.
CreditCard	setExpireYear(int expireYear) 4-digit expiration year.
CreditCard	setExternalCustomerId(java.lang.String externalCustomerId) A unique identifier of the customer to whom this bank account belongs.
CreditCard	setFirstName(java.lang.String firstName) Cardholder's first name.
CreditCard	setId(java.lang.String id) ID of the credit card.
CreditCard	setLastName(java.lang.String lastName) Cardholder's last name.
CreditCard	setLinks(java.util.List<Links> links)
CreditCard	setNumber(java.lang.String number) Credit card number.
CreditCard	setPayerId(java.lang.String payerId) Payer ID
CreditCard	setState(java.lang.String state) State of the credit card funding instrument.
CreditCard	setType(java.lang.String type) Credit card type.
CreditCard	setValidUntil(java.lang.String validUntil) Funding instrument expiration date.
CreditCard	update(APIContext apiContext, java.util.List<Patch> patchRequest) Update information in a previously saved card.
CreditCard	update(java.lang.String accessToken, java.util.List<Patch> patchRequest) Deprecated. Please use update(APIContext, List) instead.

Methods inherited from class com.paypal.base.rest.PayPalResource

configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel

toJSON, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreditCard

public CreditCard()

Default Constructor

CreditCard

public CreditCard(java.lang.String number,
                  java.lang.String type,
                  int expireMonth,
                  int expireYear)

Parameterized Constructor

Method Detail

getCvv2

public int getCvv2()

Deprecated. Please use getCvv2String() instead. Getter for cvv2 Returns -1 if cvv2 is null. Not autogenerating using lombok as it includes logic to return -1 on null.

setCvv2

public CreditCard setCvv2(java.lang.Integer cvv2)

Deprecated. The cvv2 needs to be a string, as any cvv2 starting with 0 is sent invalid to servers. Please use setCvv2(String) instead.

Parameters:

cvv2 - Integer cvv2

Returns:

CreditCard

setCvv2

public CreditCard setCvv2(java.lang.String cvv2)

Parameters:

cvv2 - String cvv2

Returns:

CreditCard

getCvv2String

public java.lang.String getCvv2String()

Returns the cvv2

Returns:

String representation of cvv2

create

public CreditCard create(java.lang.String accessToken)
                  throws PayPalRESTException

Deprecated. Please use create(APIContext) instead.

Creates a new Credit Card Resource (aka Tokenize).

Parameters:

accessToken - Access Token used for the API call.

Returns:

CreditCard

Throws:

PayPalRESTException

create

public CreditCard create(APIContext apiContext)
                  throws PayPalRESTException

Creates a new Credit Card Resource (aka Tokenize).

Parameters:

apiContext - APIContext used for the API call.

Returns:

CreditCard

Throws:

PayPalRESTException

get

public static CreditCard get(java.lang.String accessToken,
                             java.lang.String creditCardId)
                      throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Obtain the Credit Card resource for the given identifier.

Parameters:

accessToken - Access Token used for the API call.

creditCardId - String

Returns:

CreditCard

Throws:

PayPalRESTException

get

public static CreditCard get(APIContext apiContext,
                             java.lang.String creditCardId)
                      throws PayPalRESTException

Obtain the Credit Card resource for the given identifier.

Parameters:

apiContext - APIContext used for the API call.

creditCardId - String

Returns:

CreditCard

Throws:

PayPalRESTException

delete

public void delete(java.lang.String accessToken)
            throws PayPalRESTException

Deprecated. Please use delete(APIContext) instead.

Delete the Credit Card resource for the given identifier.

Parameters:

accessToken - Access Token used for the API call.

Throws:

PayPalRESTException

delete

public void delete(APIContext apiContext)
            throws PayPalRESTException

Delete the Credit Card resource for the given identifier.

Parameters:

apiContext - APIContext used for the API call.

Throws:

PayPalRESTException

update

public CreditCard update(java.lang.String accessToken,
                         java.util.List<Patch> patchRequest)
                  throws PayPalRESTException

Deprecated. Please use update(APIContext, List) instead.

Update information in a previously saved card. Only the modified fields need to be passed in the request.

Parameters:

accessToken - Access Token used for the API call.

patchRequest - List

Returns:

CreditCard

Throws:

PayPalRESTException

update

public CreditCard update(APIContext apiContext,
                         java.util.List<Patch> patchRequest)
                  throws PayPalRESTException

Update information in a previously saved card. Only the modified fields need to be passed in the request.

Parameters:

apiContext - APIContext used for the API call.

patchRequest - List

Returns:

CreditCard

Throws:

PayPalRESTException

list

public static CreditCardHistory list(java.lang.String accessToken,
                                     java.util.Map<java.lang.String,java.lang.String> containerMap)
                              throws PayPalRESTException

Deprecated. Please use list(APIContext, Map) instead.

Retrieves a list of Credit Card resources.

Parameters:

accessToken - Access Token used for the API call.

containerMap - Map. See https://developer.paypal.com/webapps/developer/docs/api/#list-credit-card-resources

Returns:

CreditCardHistory

Throws:

PayPalRESTException

list

public static CreditCardHistory list(APIContext apiContext,
                                     java.util.Map<java.lang.String,java.lang.String> containerMap)
                              throws PayPalRESTException

Retrieves a list of Credit Card resources.

Parameters:

apiContext - APIContext used for the API call.

containerMap - Map. See https://developer.paypal.com/webapps/developer/docs/api/#list-credit-card-resources

Returns:

CreditCardHistory

Throws:

PayPalRESTException

list

public static CreditCardHistory list(APIContext apiContext)
                              throws PayPalRESTException

Retrieves a list of Credit Card resources.

Parameters:

apiContext - APIContext used for the API call.

Returns:

CreditCardHistory

Throws:

PayPalRESTException

list

public static CreditCardHistory list(java.lang.String accessToken)
                              throws PayPalRESTException

Deprecated. Please use list(APIContext, Map) instead.

Retrieves a list of Credit Card resources. containerMap (filters) are set to defaults.

Parameters:

accessToken - Access Token used for the API call.

Returns:

CreditCardHistory

Throws:

PayPalRESTException

getId

public java.lang.String getId()

ID of the credit card. This ID is provided in the response when storing credit cards. **Required if using a stored credit card.**

getNumber

public java.lang.String getNumber()

Credit card number. Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type. *Redacted in responses.*

getType

public java.lang.String getType()

Credit card type. Valid types are: `visa`, `mastercard`, `discover`, `amex`

getExpireMonth

public int getExpireMonth()

Expiration month with no leading zero. Acceptable values are 1 through 12.

getExpireYear

public int getExpireYear()

4-digit expiration year.

getFirstName

public java.lang.String getFirstName()

Cardholder's first name.

getLastName

public java.lang.String getLastName()

Cardholder's last name.

getBillingAddress

public Address getBillingAddress()

Billing Address associated with this card.

getExternalCustomerId

public java.lang.String getExternalCustomerId()

A unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator. **This is now used in favor of `payer_id` when creating or using a stored funding instrument in the vault.**

getState

public java.lang.String getState()

State of the credit card funding instrument.

getValidUntil

public java.lang.String getValidUntil()

Funding instrument expiration date.

getLinks

public java.util.List<Links> getLinks()

getPayerId

public java.lang.String getPayerId()

Payer ID

setId

public CreditCard setId(java.lang.String id)

ID of the credit card. This ID is provided in the response when storing credit cards. **Required if using a stored credit card.**

Returns:

this

setNumber

public CreditCard setNumber(java.lang.String number)

Credit card number. Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type. *Redacted in responses.*

Returns:

this

setType

public CreditCard setType(java.lang.String type)

Credit card type. Valid types are: `visa`, `mastercard`, `discover`, `amex`

Returns:

this

setExpireMonth

public CreditCard setExpireMonth(int expireMonth)

Expiration month with no leading zero. Acceptable values are 1 through 12.

Returns:

this

setExpireYear

public CreditCard setExpireYear(int expireYear)

4-digit expiration year.

Returns:

this

setFirstName

public CreditCard setFirstName(java.lang.String firstName)

Cardholder's first name.

Returns:

this

setLastName

public CreditCard setLastName(java.lang.String lastName)

Cardholder's last name.

Returns:

this

setBillingAddress

public CreditCard setBillingAddress(Address billingAddress)

Billing Address associated with this card.

Returns:

this

setExternalCustomerId

public CreditCard setExternalCustomerId(java.lang.String externalCustomerId)

A unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator. **This is now used in favor of `payer_id` when creating or using a stored funding instrument in the vault.**

Returns:

this

setState

public CreditCard setState(java.lang.String state)

State of the credit card funding instrument.

Returns:

this

setValidUntil

public CreditCard setValidUntil(java.lang.String validUntil)

Funding instrument expiration date.

Returns:

this

setLinks

public CreditCard setLinks(java.util.List<Links> links)

Returns:

this

setPayerId

public CreditCard setPayerId(java.lang.String payerId)

Payer ID

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PayPalModel

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class PayPalModel

hashCode

public int hashCode()

Overrides:

hashCode in class PayPalModel