CardRequest (PayPal Server SDK 1.0.0 API)

java.lang.Object
- com.paypal.sdk.models.CardRequest

```
public class CardRequest
extends Object
```
This is a model class for CardRequest type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CardRequest.Builder
Class to build instances of CardRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CardRequest.Builder` Class to build instances of `CardRequest`.

Constructor Summary

Constructors
Constructor and Description
`CardRequest()` Default constructor.
`CardRequest(String name, String number, String expiry, String securityCode, Address billingAddress, CardAttributes attributes, String vaultId, String singleUseToken, CardStoredCredential storedCredential, NetworkToken networkToken, CardExperienceContext experienceContext)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CardAttributes`	`getAttributes()` Getter for Attributes.
`Address`	`getBillingAddress()` Getter for BillingAddress.
`CardExperienceContext`	`getExperienceContext()` Getter for ExperienceContext.
`String`	`getExpiry()` Getter for Expiry.
`String`	`getName()` Getter for Name.
`NetworkToken`	`getNetworkToken()` Getter for NetworkToken.
`String`	`getNumber()` Getter for Number.
`String`	`getSecurityCode()` Getter for SecurityCode.
`String`	`getSingleUseToken()` Getter for SingleUseToken.
`CardStoredCredential`	`getStoredCredential()` Getter for StoredCredential.
`String`	`getVaultId()` Getter for VaultId.
`void`	`setAttributes(CardAttributes attributes)` Setter for Attributes.
`void`	`setBillingAddress(Address billingAddress)` Setter for BillingAddress.
`void`	`setExperienceContext(CardExperienceContext experienceContext)` Setter for ExperienceContext.
`void`	`setExpiry(String expiry)` Setter for Expiry.
`void`	`setName(String name)` Setter for Name.
`void`	`setNetworkToken(NetworkToken networkToken)` Setter for NetworkToken.
`void`	`setNumber(String number)` Setter for Number.
`void`	`setSecurityCode(String securityCode)` Setter for SecurityCode.
`void`	`setSingleUseToken(String singleUseToken)` Setter for SingleUseToken.
`void`	`setStoredCredential(CardStoredCredential storedCredential)` Setter for StoredCredential.
`void`	`setVaultId(String vaultId)` Setter for VaultId.
`CardRequest.Builder`	`toBuilder()` Builds a new `CardRequest.Builder` object.
`String`	`toString()` Converts this CardRequest into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CardRequest
```
public CardRequest()
```
    Default constructor.
  - CardRequest
```
public CardRequest(String name,
                   String number,
                   String expiry,
                   String securityCode,
                   Address billingAddress,
                   CardAttributes attributes,
                   String vaultId,
                   String singleUseToken,
                   CardStoredCredential storedCredential,
                   NetworkToken networkToken,
                   CardExperienceContext experienceContext)
```
    Initialization constructor.
    
    Parameters:
    
    name - String value for name.
    
    number - String value for number.
    
    expiry - String value for expiry.
    
    securityCode - String value for securityCode.
    
    billingAddress - Address value for billingAddress.
    
    attributes - CardAttributes value for attributes.
    
    vaultId - String value for vaultId.
    
    singleUseToken - String value for singleUseToken.
    
    storedCredential - CardStoredCredential value for storedCredential.
    
    networkToken - NetworkToken value for networkToken.
    
    experienceContext - CardExperienceContext value for experienceContext.
- Method Detail
  - getName
```
public String getName()
```
    Getter for Name. The card holder's name as it appears on the card.
    
    Returns:
    
    Returns the String
  - setName
```
public void setName(String name)
```
    Setter for Name. The card holder's name as it appears on the card.
    
    Parameters:
    
    name - Value for String
  - getNumber
```
public String getNumber()
```
    Getter for Number. The primary account number (PAN) for the payment card.
    
    Returns:
    
    Returns the String
  - setNumber
```
public void setNumber(String number)
```
    Setter for Number. The primary account number (PAN) for the payment card.
    
    Parameters:
    
    number - Value for String
  - getExpiry
```
public String getExpiry()
```
    Getter for Expiry. The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    Returns the String
  - setExpiry
```
public void setExpiry(String expiry)
```
    Setter for Expiry. The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
    
    Parameters:
    
    expiry - Value for String
  - getSecurityCode
```
public String getSecurityCode()
```
    Getter for 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`.
    
    Returns:
    
    Returns the String
  - setSecurityCode
```
public void setSecurityCode(String securityCode)
```
    Setter for 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`.
    
    Parameters:
    
    securityCode - Value for String
  - getBillingAddress
```
public Address getBillingAddress()
```
    Getter for BillingAddress. The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).
    
    Returns:
    
    Returns the Address
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
    Setter for BillingAddress. The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).
    
    Parameters:
    
    billingAddress - Value for Address
  - getAttributes
```
public CardAttributes getAttributes()
```
    Getter for Attributes. Additional attributes associated with the use of this card.
    
    Returns:
    
    Returns the CardAttributes
  - setAttributes
```
public void setAttributes(CardAttributes attributes)
```
    Setter for Attributes. Additional attributes associated with the use of this card.
    
    Parameters:
    
    attributes - Value for CardAttributes
  - getVaultId
```
public String getVaultId()
```
    Getter for VaultId. The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
    
    Returns:
    
    Returns the String
  - setVaultId
```
public void setVaultId(String vaultId)
```
    Setter for VaultId. The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
    
    Parameters:
    
    vaultId - Value for String
  - getSingleUseToken
```
public String getSingleUseToken()
```
    Getter for SingleUseToken. The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.
    
    Returns:
    
    Returns the String
  - setSingleUseToken
```
public void setSingleUseToken(String singleUseToken)
```
    Setter for SingleUseToken. The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.
    
    Parameters:
    
    singleUseToken - Value for String
  - getStoredCredential
```
public CardStoredCredential getStoredCredential()
```
    Getter for 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.
    
    Returns:
    
    Returns the CardStoredCredential
  - setStoredCredential
```
public void setStoredCredential(CardStoredCredential storedCredential)
```
    Setter for 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.
    
    Parameters:
    
    storedCredential - Value for CardStoredCredential
  - getNetworkToken
```
public NetworkToken getNetworkToken()
```
    Getter for NetworkToken. The Third Party Network token used to fund a payment.
    
    Returns:
    
    Returns the NetworkToken
  - setNetworkToken
```
public void setNetworkToken(NetworkToken networkToken)
```
    Setter for NetworkToken. The Third Party Network token used to fund a payment.
    
    Parameters:
    
    networkToken - Value for NetworkToken
  - getExperienceContext
```
public CardExperienceContext getExperienceContext()
```
    Getter for ExperienceContext. Customizes the payer experience during the 3DS Approval for payment.
    
    Returns:
    
    Returns the CardExperienceContext
  - setExperienceContext
```
public void setExperienceContext(CardExperienceContext experienceContext)
```
    Setter for ExperienceContext. Customizes the payer experience during the 3DS Approval for payment.
    
    Parameters:
    
    experienceContext - Value for CardExperienceContext
  - toString
```
public String toString()
```
    Converts this CardRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public CardRequest.Builder toBuilder()
```
    Builds a new CardRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new CardRequest.Builder object

Class CardRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CardRequest

CardRequest

Method Detail

getName

setName

getNumber

setNumber

getExpiry

setExpiry

getSecurityCode

setSecurityCode

getBillingAddress

setBillingAddress

getAttributes

setAttributes

getVaultId

setVaultId

getSingleUseToken

setSingleUseToken

getStoredCredential

setStoredCredential

getNetworkToken

setNetworkToken

getExperienceContext

setExperienceContext

toString

toBuilder