com.paypal.sdk.models

Class PaypalWalletVaultInstruction

java.lang.Object

com.paypal.sdk.models.PaypalWalletVaultInstruction

public class PaypalWalletVaultInstruction
extends Object

This is a model class for PaypalWalletVaultInstruction type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaypalWalletVaultInstruction.Builder Class to build instances of PaypalWalletVaultInstruction.

Constructor Summary

Constructors

Constructor and Description
PaypalWalletVaultInstruction() Default constructor.
PaypalWalletVaultInstruction(PaypalPaymentTokenUsageType usageType, StoreInVaultInstruction storeInVault, String description, UsagePattern usagePattern, PaypalPaymentTokenCustomerType customerType, Boolean permitMultiplePaymentTokens) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
PaypalPaymentTokenCustomerType	getCustomerType() Getter for CustomerType.
String	getDescription() Getter for Description.
Boolean	getPermitMultiplePaymentTokens() Getter for PermitMultiplePaymentTokens.
StoreInVaultInstruction	getStoreInVault() Getter for StoreInVault.
UsagePattern	getUsagePattern() Getter for UsagePattern.
PaypalPaymentTokenUsageType	getUsageType() Getter for UsageType.
void	setCustomerType(PaypalPaymentTokenCustomerType customerType) Setter for CustomerType.
void	setDescription(String description) Setter for Description.
void	setPermitMultiplePaymentTokens(Boolean permitMultiplePaymentTokens) Setter for PermitMultiplePaymentTokens.
void	setStoreInVault(StoreInVaultInstruction storeInVault) Setter for StoreInVault.
void	setUsagePattern(UsagePattern usagePattern) Setter for UsagePattern.
void	setUsageType(PaypalPaymentTokenUsageType usageType) Setter for UsageType.
PaypalWalletVaultInstruction.Builder	toBuilder() Builds a new PaypalWalletVaultInstruction.Builder object.
String	toString() Converts this PaypalWalletVaultInstruction into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaypalWalletVaultInstruction

public PaypalWalletVaultInstruction()

Default constructor.

PaypalWalletVaultInstruction

public PaypalWalletVaultInstruction(PaypalPaymentTokenUsageType usageType,
                                    StoreInVaultInstruction storeInVault,
                                    String description,
                                    UsagePattern usagePattern,
                                    PaypalPaymentTokenCustomerType customerType,
                                    Boolean permitMultiplePaymentTokens)

Initialization constructor.

Parameters:

usageType - PaypalPaymentTokenUsageType value for usageType.

storeInVault - StoreInVaultInstruction value for storeInVault.

description - String value for description.

usagePattern - UsagePattern value for usagePattern.

customerType - PaypalPaymentTokenCustomerType value for customerType.

permitMultiplePaymentTokens - Boolean value for permitMultiplePaymentTokens.

Method Detail

getStoreInVault

public StoreInVaultInstruction getStoreInVault()

Getter for StoreInVault. Defines how and when the payment source gets vaulted.

Returns:

Returns the StoreInVaultInstruction

setStoreInVault

public void setStoreInVault(StoreInVaultInstruction storeInVault)

Setter for StoreInVault. Defines how and when the payment source gets vaulted.

Parameters:

storeInVault - Value for StoreInVaultInstruction

getDescription

public String getDescription()

Getter for Description. The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.

Returns:

Returns the String

setDescription

public void setDescription(String description)

Setter for Description. The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.

Parameters:

description - Value for String

getUsagePattern

public UsagePattern getUsagePattern()

Getter for UsagePattern. Expected business/pricing model for the billing agreement.

Returns:

Returns the UsagePattern

setUsagePattern

public void setUsagePattern(UsagePattern usagePattern)

Setter for UsagePattern. Expected business/pricing model for the billing agreement.

Parameters:

usagePattern - Value for UsagePattern

getUsageType

public PaypalPaymentTokenUsageType getUsageType()

Getter for UsageType. The usage type associated with the PayPal payment token.

Returns:

Returns the PaypalPaymentTokenUsageType

setUsageType

public void setUsageType(PaypalPaymentTokenUsageType usageType)

Setter for UsageType. The usage type associated with the PayPal payment token.

Parameters:

usageType - Value for PaypalPaymentTokenUsageType

getCustomerType

public PaypalPaymentTokenCustomerType getCustomerType()

Getter for CustomerType. The customer type associated with the PayPal 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 the PayPal 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

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

toString

public String toString()

Converts this PaypalWalletVaultInstruction into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PaypalWalletVaultInstruction.Builder toBuilder()

Builds a new PaypalWalletVaultInstruction.Builder object. Creates the instance with the state of the current model.

Returns:

a new PaypalWalletVaultInstruction.Builder object