PaypalPaymentToken (PayPal Server SDK 1.0.0 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`PaypalPaymentToken()` Default constructor.
`PaypalPaymentToken(String description, UsagePattern usagePattern, VaultedDigitalWalletShippingDetails shipping, Boolean permitMultiplePaymentTokens, PaypalPaymentTokenUsageType usageType, PaypalPaymentTokenCustomerType customerType, String emailAddress, String payerId, Name name, PhoneWithType phone, Address address, String accountId, Phone phoneNumber)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccountId()` Getter for AccountId.
`Address`	`getAddress()` Getter for Address.
`PaypalPaymentTokenCustomerType`	`getCustomerType()` Getter for CustomerType.
`String`	`getDescription()` Getter for Description.
`String`	`getEmailAddress()` Getter for EmailAddress.
`Name`	`getName()` Getter for Name.
`String`	`getPayerId()` Getter for PayerId.
`Boolean`	`getPermitMultiplePaymentTokens()` Getter for PermitMultiplePaymentTokens.
`PhoneWithType`	`getPhone()` Getter for Phone.
`Phone`	`getPhoneNumber()` Getter for PhoneNumber.
`VaultedDigitalWalletShippingDetails`	`getShipping()` Getter for Shipping.
`UsagePattern`	`getUsagePattern()` Getter for UsagePattern.
`PaypalPaymentTokenUsageType`	`getUsageType()` Getter for UsageType.
`void`	`setAccountId(String accountId)` Setter for AccountId.
`void`	`setAddress(Address address)` Setter for Address.
`void`	`setCustomerType(PaypalPaymentTokenCustomerType customerType)` Setter for CustomerType.
`void`	`setDescription(String description)` Setter for Description.
`void`	`setEmailAddress(String emailAddress)` Setter for EmailAddress.
`void`	`setName(Name name)` Setter for Name.
`void`	`setPayerId(String payerId)` Setter for PayerId.
`void`	`setPermitMultiplePaymentTokens(Boolean permitMultiplePaymentTokens)` Setter for PermitMultiplePaymentTokens.
`void`	`setPhone(PhoneWithType phone)` Setter for Phone.
`void`	`setPhoneNumber(Phone phoneNumber)` Setter for PhoneNumber.
`void`	`setShipping(VaultedDigitalWalletShippingDetails shipping)` Setter for Shipping.
`void`	`setUsagePattern(UsagePattern usagePattern)` Setter for UsagePattern.
`void`	`setUsageType(PaypalPaymentTokenUsageType usageType)` Setter for UsageType.
`PaypalPaymentToken.Builder`	`toBuilder()` Builds a new `PaypalPaymentToken.Builder` object.
`String`	`toString()` Converts this PaypalPaymentToken into string format.

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

- Constructor Detail
  - PaypalPaymentToken
```
public PaypalPaymentToken()
```
    Default constructor.
  - PaypalPaymentToken
```
public PaypalPaymentToken(String description,
                          UsagePattern usagePattern,
                          VaultedDigitalWalletShippingDetails shipping,
                          Boolean permitMultiplePaymentTokens,
                          PaypalPaymentTokenUsageType usageType,
                          PaypalPaymentTokenCustomerType customerType,
                          String emailAddress,
                          String payerId,
                          Name name,
                          PhoneWithType phone,
                          Address address,
                          String accountId,
                          Phone phoneNumber)
```
    Initialization constructor.
    
    Parameters:
    
    description - String value for description.
    
    usagePattern - UsagePattern value for usagePattern.
    
    shipping - VaultedDigitalWalletShippingDetails value for shipping.
    
    permitMultiplePaymentTokens - Boolean value for permitMultiplePaymentTokens.
    
    usageType - PaypalPaymentTokenUsageType value for usageType.
    
    customerType - PaypalPaymentTokenCustomerType value for customerType.
    
    emailAddress - String value for emailAddress.
    
    payerId - String value for payerId.
    
    name - Name value for name.
    
    phone - PhoneWithType value for phone.
    
    address - Address value for address.
    
    accountId - String value for accountId.
    
    phoneNumber - Phone value for phoneNumber.
- Method Detail
  - getDescription
```
public String getDescription()
```
    Getter for Description. The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
    
    Returns:
    
    Returns the String
  - setDescription
```
public void setDescription(String description)
```
    Setter for Description. The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
    
    Parameters:
    
    description - Value for String
  - getUsagePattern
```
public UsagePattern getUsagePattern()
```
    Getter for UsagePattern. Expected business/charge model for the billing agreement.
    
    Returns:
    
    Returns the UsagePattern
  - setUsagePattern
```
public void setUsagePattern(UsagePattern usagePattern)
```
    Setter for UsagePattern. Expected business/charge model for the billing agreement.
    
    Parameters:
    
    usagePattern - Value for UsagePattern
  - getShipping
```
public VaultedDigitalWalletShippingDetails getShipping()
```
    Getter for Shipping. The shipping details.
    
    Returns:
    
    Returns the VaultedDigitalWalletShippingDetails
  - setShipping
```
public void setShipping(VaultedDigitalWalletShippingDetails shipping)
```
    Setter for Shipping. The shipping details.
    
    Parameters:
    
    shipping - Value for VaultedDigitalWalletShippingDetails
  - getPermitMultiplePaymentTokens
```
public Boolean getPermitMultiplePaymentTokens()
```
    Getter for PermitMultiplePaymentTokens. Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
    
    Returns:
    
    Returns the Boolean
  - setPermitMultiplePaymentTokens
```
public void setPermitMultiplePaymentTokens(Boolean permitMultiplePaymentTokens)
```
    Setter for PermitMultiplePaymentTokens. Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
    
    Parameters:
    
    permitMultiplePaymentTokens - Value for Boolean
  - getUsageType
```
public PaypalPaymentTokenUsageType getUsageType()
```
    Getter for UsageType. The usage type associated with a digital wallet payment token.
    
    Returns:
    
    Returns the PaypalPaymentTokenUsageType
  - setUsageType
```
public void setUsageType(PaypalPaymentTokenUsageType usageType)
```
    Setter for UsageType. The usage type associated with a digital wallet payment token.
    
    Parameters:
    
    usageType - Value for PaypalPaymentTokenUsageType
  - getCustomerType
```
public PaypalPaymentTokenCustomerType getCustomerType()
```
    Getter for CustomerType. The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
    
    Returns:
    
    Returns the PaypalPaymentTokenCustomerType
  - setCustomerType
```
public void setCustomerType(PaypalPaymentTokenCustomerType customerType)
```
    Setter for CustomerType. The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
    
    Parameters:
    
    customerType - Value for PaypalPaymentTokenCustomerType
  - 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
  - getPayerId
```
public String getPayerId()
```
    Getter for PayerId. The account identifier for a PayPal account.
    
    Returns:
    
    Returns the String
  - setPayerId
```
public void setPayerId(String payerId)
```
    Setter for PayerId. The account identifier for a PayPal account.
    
    Parameters:
    
    payerId - Value for String
  - getName
```
public Name getName()
```
    Getter for Name. The name of the party.
    
    Returns:
    
    Returns the Name
  - setName
```
public void setName(Name name)
```
    Setter for Name. The name of the party.
    
    Parameters:
    
    name - Value for Name
  - getPhone
```
public PhoneWithType getPhone()
```
    Getter for Phone. The phone information.
    
    Returns:
    
    Returns the PhoneWithType
  - setPhone
```
public void setPhone(PhoneWithType phone)
```
    Setter for Phone. The phone information.
    
    Parameters:
    
    phone - Value for PhoneWithType
  - getAddress
```
public Address getAddress()
```
    Getter for Address. 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
  - setAddress
```
public void setAddress(Address address)
```
    Setter for Address. 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:
    
    address - Value for Address
  - getAccountId
```
public String getAccountId()
```
    Getter for AccountId. The account identifier for a PayPal account.
    
    Returns:
    
    Returns the String
  - setAccountId
```
public void setAccountId(String accountId)
```
    Setter for AccountId. The account identifier for a PayPal account.
    
    Parameters:
    
    accountId - Value for String
  - getPhoneNumber
```
public Phone 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 Phone
  - setPhoneNumber
```
public void setPhoneNumber(Phone 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 Phone
  - toString
```
public String toString()
```
    Converts this PaypalPaymentToken into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public PaypalPaymentToken.Builder toBuilder()
```
    Builds a new PaypalPaymentToken.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new PaypalPaymentToken.Builder object

Class PaypalPaymentToken

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaypalPaymentToken

PaypalPaymentToken

Method Detail

getDescription

setDescription

getUsagePattern

setUsagePattern

getShipping

setShipping

getPermitMultiplePaymentTokens

setPermitMultiplePaymentTokens

getUsageType

setUsageType

getCustomerType

setCustomerType

getEmailAddress

setEmailAddress

getPayerId

setPayerId

getName

setName

getPhone

setPhone

getAddress

setAddress

getAccountId

setAccountId

getPhoneNumber

setPhoneNumber

toString

toBuilder