com.paypal.sdk.models

Class VaultPaypalWalletRequest

java.lang.Object

com.paypal.sdk.models.VaultPaypalWalletRequest

public class VaultPaypalWalletRequest
extends Object

This is a model class for VaultPaypalWalletRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
VaultPaypalWalletRequest() Default constructor.
VaultPaypalWalletRequest(String description, UsagePattern usagePattern, VaultedDigitalWalletShippingDetails shipping, Boolean permitMultiplePaymentTokens, PaypalPaymentTokenUsageType usageType, PaypalPaymentTokenCustomerType customerType, Plan billingPlan, VaultExperienceContext experienceContext) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Plan	getBillingPlan() Getter for BillingPlan.
PaypalPaymentTokenCustomerType	getCustomerType() Getter for CustomerType.
String	getDescription() Getter for Description.
VaultExperienceContext	getExperienceContext() Getter for ExperienceContext.
Boolean	getPermitMultiplePaymentTokens() Getter for PermitMultiplePaymentTokens.
VaultedDigitalWalletShippingDetails	getShipping() Getter for Shipping.
UsagePattern	getUsagePattern() Getter for UsagePattern.
PaypalPaymentTokenUsageType	getUsageType() Getter for UsageType.
void	setBillingPlan(Plan billingPlan) Setter for BillingPlan.
void	setCustomerType(PaypalPaymentTokenCustomerType customerType) Setter for CustomerType.
void	setDescription(String description) Setter for Description.
void	setExperienceContext(VaultExperienceContext experienceContext) Setter for ExperienceContext.
void	setPermitMultiplePaymentTokens(Boolean permitMultiplePaymentTokens) Setter for PermitMultiplePaymentTokens.
void	setShipping(VaultedDigitalWalletShippingDetails shipping) Setter for Shipping.
void	setUsagePattern(UsagePattern usagePattern) Setter for UsagePattern.
void	setUsageType(PaypalPaymentTokenUsageType usageType) Setter for UsageType.
VaultPaypalWalletRequest.Builder	toBuilder() Builds a new VaultPaypalWalletRequest.Builder object.
String	toString() Converts this VaultPaypalWalletRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultPaypalWalletRequest

public VaultPaypalWalletRequest()

Default constructor.

VaultPaypalWalletRequest

public VaultPaypalWalletRequest(String description,
                                UsagePattern usagePattern,
                                VaultedDigitalWalletShippingDetails shipping,
                                Boolean permitMultiplePaymentTokens,
                                PaypalPaymentTokenUsageType usageType,
                                PaypalPaymentTokenCustomerType customerType,
                                Plan billingPlan,
                                VaultExperienceContext experienceContext)

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.

billingPlan - Plan value for billingPlan.

experienceContext - VaultExperienceContext value for experienceContext.

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

getBillingPlan

public Plan getBillingPlan()

Getter for BillingPlan. The merchant level Recurring Billing plan metadata for the Billing Agreement.

Returns:

Returns the Plan

setBillingPlan

public void setBillingPlan(Plan billingPlan)

Setter for BillingPlan. The merchant level Recurring Billing plan metadata for the Billing Agreement.

Parameters:

billingPlan - Value for Plan

getExperienceContext

public VaultExperienceContext getExperienceContext()

Getter for ExperienceContext. Customizes the Vault creation flow experience for your customers.

Returns:

Returns the VaultExperienceContext

setExperienceContext

public void setExperienceContext(VaultExperienceContext experienceContext)

Setter for ExperienceContext. Customizes the Vault creation flow experience for your customers.

Parameters:

experienceContext - Value for VaultExperienceContext

toString

public String toString()

Converts this VaultPaypalWalletRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public VaultPaypalWalletRequest.Builder toBuilder()

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

Returns:

a new VaultPaypalWalletRequest.Builder object