Package com.broadleafcommerce.paypal.micro.gateway.domain.payments

Class CardRequest

java.lang.Object

com.broadleafcommerce.paypal.micro.gateway.domain.payments.CardRequest

All Implemented Interfaces:

Serializable

public class CardRequest
extends Object
implements Serializable

Author:

Dima Myroniuk (dmyroniuk)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CardRequest()

Method Summary

Modifier and Type	Method	Description
AddressPortable	getBillingAddress()	The billing address for this card.
String	getExpiry()	The card expiration year and month, in Internet date and time format.
String	getName()	The card holder's name as it appears on the card.
String	getNumber()	The primary account number (PAN) for the payment card.
String	getSecurityCode()	The three- or four-digit security code of the card.
CardStoredCredential	getStoredCredential()	Provides additional details to process a payment using a "card" that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
String	getVaultId()	The PayPal-generated ID for the saved card payment source.
void	setBillingAddress(AddressPortable billingAddress)	The billing address for this card.
void	setExpiry(String expiry)	The card expiration year and month, in Internet date and time format.
void	setName(String name)	The card holder's name as it appears on the card.
void	setNumber(String number)	The primary account number (PAN) for the payment card.
void	setSecurityCode(String securityCode)	The three- or four-digit security code of the card.
void	setStoredCredential(CardStoredCredential storedCredential)	Provides additional details to process a payment using a "card" that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
void	setVaultId(String vaultId)	The PayPal-generated ID for the saved card payment source.

Methods inherited from class java.lang.Object

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

Constructor Detail

CardRequest

public CardRequest()

Method Detail

setBillingAddress

public void setBillingAddress(AddressPortable billingAddress)

The billing address for this card. Supports only the "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", and "country_code" properties.

setExpiry

public void setExpiry(String expiry)

The card expiration year and month, in Internet date and time format.

setName

public void setName(String name)

The card holder's name as it appears on the card.

setNumber

public void setNumber(String number)

The primary account number (PAN) for the payment card.

setSecurityCode

public void setSecurityCode(String securityCode)

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when "payment_initiator=MERCHANT".

setStoredCredential

public void setStoredCredential(CardStoredCredential storedCredential)

Provides additional details to process a payment using a "card" that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility:

• "payment_type=ONE_TIME" is compatible only with "payment_initiator=CUSTOMER".
• "usage=FIRST" is compatible only with "payment_initiator=CUSTOMER".
• "previous_transaction_reference" or "previous_network_transaction_reference" is compatible only with "payment_initiator=MERCHANT".
• Only one of the parameters - "previous_transaction_reference" and "previous_network_transaction_reference" - can be present in the request.

setVaultId

public void setVaultId(String vaultId)

The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.

getBillingAddress

public AddressPortable getBillingAddress()

The billing address for this card. Supports only the "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", and "country_code" properties.

getExpiry

public String getExpiry()

The card expiration year and month, in Internet date and time format.

getName

public String getName()

The card holder's name as it appears on the card.

getNumber

public String getNumber()

The primary account number (PAN) for the payment card.

getSecurityCode

public String getSecurityCode()

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when "payment_initiator=MERCHANT".

getStoredCredential

public CardStoredCredential getStoredCredential()

Provides additional details to process a payment using a "card" that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility:

• "payment_type=ONE_TIME" is compatible only with "payment_initiator=CUSTOMER".
• "usage=FIRST" is compatible only with "payment_initiator=CUSTOMER".
• "previous_transaction_reference" or "previous_network_transaction_reference" is compatible only with "payment_initiator=MERCHANT".
• Only one of the parameters - "previous_transaction_reference" and "previous_network_transaction_reference" - can be present in the request.

getVaultId

public String getVaultId()

The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.