ApplePayRequest (PayPal Server SDK 1.0.0 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`ApplePayRequest()` Default constructor.
`ApplePayRequest(String id, String name, String emailAddress, PhoneNumber phoneNumber, ApplePayDecryptedTokenData decryptedToken, CardStoredCredential storedCredential, String vaultId, ApplePayAttributes attributes)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplePayAttributes`	`getAttributes()` Getter for Attributes.
`ApplePayDecryptedTokenData`	`getDecryptedToken()` Getter for DecryptedToken.
`String`	`getEmailAddress()` Getter for EmailAddress.
`String`	`getId()` Getter for Id.
`String`	`getName()` Getter for Name.
`PhoneNumber`	`getPhoneNumber()` Getter for PhoneNumber.
`CardStoredCredential`	`getStoredCredential()` Getter for StoredCredential.
`String`	`getVaultId()` Getter for VaultId.
`void`	`setAttributes(ApplePayAttributes attributes)` Setter for Attributes.
`void`	`setDecryptedToken(ApplePayDecryptedTokenData decryptedToken)` Setter for DecryptedToken.
`void`	`setEmailAddress(String emailAddress)` Setter for EmailAddress.
`void`	`setId(String id)` Setter for Id.
`void`	`setName(String name)` Setter for Name.
`void`	`setPhoneNumber(PhoneNumber phoneNumber)` Setter for PhoneNumber.
`void`	`setStoredCredential(CardStoredCredential storedCredential)` Setter for StoredCredential.
`void`	`setVaultId(String vaultId)` Setter for VaultId.
`ApplePayRequest.Builder`	`toBuilder()` Builds a new `ApplePayRequest.Builder` object.
`String`	`toString()` Converts this ApplePayRequest into string format.

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

- Constructor Detail
  - ApplePayRequest
```
public ApplePayRequest()
```
    Default constructor.
  - ApplePayRequest
```
public ApplePayRequest(String id,
                       String name,
                       String emailAddress,
                       PhoneNumber phoneNumber,
                       ApplePayDecryptedTokenData decryptedToken,
                       CardStoredCredential storedCredential,
                       String vaultId,
                       ApplePayAttributes attributes)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    name - String value for name.
    
    emailAddress - String value for emailAddress.
    
    phoneNumber - PhoneNumber value for phoneNumber.
    
    decryptedToken - ApplePayDecryptedTokenData value for decryptedToken.
    
    storedCredential - CardStoredCredential value for storedCredential.
    
    vaultId - String value for vaultId.
    
    attributes - ApplePayAttributes value for attributes.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
    
    Returns:
    
    Returns the String
  - setId
```
public void setId(String id)
```
    Setter for Id. ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
    
    Parameters:
    
    id - Value for String
  - getName
```
public String getName()
```
    Getter for Name. The full name representation like Mr J Smith.
    
    Returns:
    
    Returns the String
  - setName
```
public void setName(String name)
```
    Setter for Name. The full name representation like Mr J Smith.
    
    Parameters:
    
    name - Value for String
  - getEmailAddress
```
public String getEmailAddress()
```
    Getter for EmailAddress. The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.
    
    Returns:
    
    Returns the String
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
    Setter for EmailAddress. The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.
    
    Parameters:
    
    emailAddress - Value for String
  - getPhoneNumber
```
public PhoneNumber getPhoneNumber()
```
    Getter for PhoneNumber. The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
    
    Returns:
    
    Returns the PhoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(PhoneNumber phoneNumber)
```
    Setter for PhoneNumber. The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
    
    Parameters:
    
    phoneNumber - Value for PhoneNumber
  - getDecryptedToken
```
public ApplePayDecryptedTokenData getDecryptedToken()
```
    Getter for DecryptedToken. Information about the Payment data obtained by decrypting Apple Pay token.
    
    Returns:
    
    Returns the ApplePayDecryptedTokenData
  - setDecryptedToken
```
public void setDecryptedToken(ApplePayDecryptedTokenData decryptedToken)
```
    Setter for DecryptedToken. Information about the Payment data obtained by decrypting Apple Pay token.
    
    Parameters:
    
    decryptedToken - Value for ApplePayDecryptedTokenData
  - 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
  - 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
  - getAttributes
```
public ApplePayAttributes getAttributes()
```
    Getter for Attributes. Additional attributes associated with apple pay.
    
    Returns:
    
    Returns the ApplePayAttributes
  - setAttributes
```
public void setAttributes(ApplePayAttributes attributes)
```
    Setter for Attributes. Additional attributes associated with apple pay.
    
    Parameters:
    
    attributes - Value for ApplePayAttributes
  - toString
```
public String toString()
```
    Converts this ApplePayRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public ApplePayRequest.Builder toBuilder()
```
    Builds a new ApplePayRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new ApplePayRequest.Builder object

Class ApplePayRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplePayRequest

ApplePayRequest

Method Detail

getId

setId

getName

setName

getEmailAddress

setEmailAddress

getPhoneNumber

setPhoneNumber

getDecryptedToken

setDecryptedToken

getStoredCredential

setStoredCredential

getVaultId

setVaultId

getAttributes

setAttributes

toString

toBuilder