PayPal-PHP-Server-SDK/doc/models/vault-paypal-wallet-request.md

Vault Paypal Wallet Request

A resource representing a request to vault PayPal Wallet.

Structure

VaultPaypalWalletRequest

Fields

Name	Type	Tags	Description	Getter	Setter
description	?string	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 128, Pattern: ^.*$	getDescription(): ?string	setDescription(?string description): void
usagePattern	?string(UsagePattern)	Optional	Expected business/charge model for the billing agreement. Constraints: Minimum Length: 1, Maximum Length: 30, Pattern: ^[0-9A-Z_]+$	getUsagePattern(): ?string	setUsagePattern(?string usagePattern): void
shipping	?VaultedDigitalWalletShippingDetails	Optional	The shipping details.	getShipping(): ?VaultedDigitalWalletShippingDetails	setShipping(?VaultedDigitalWalletShippingDetails shipping): void
permitMultiplePaymentTokens	?bool	Optional	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. Default: false	getPermitMultiplePaymentTokens(): ?bool	setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void
usageType	?string(PaypalPaymentTokenUsageType)	Optional	The usage type associated with a digital wallet payment token. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getUsageType(): ?string	setUsageType(?string usageType): void
customerType	?string(PaypalPaymentTokenCustomerType)	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getCustomerType(): ?string	setCustomerType(?string customerType): void
billingPlan	?Plan	Optional	The merchant level Recurring Billing plan metadata for the Billing Agreement.	getBillingPlan(): ?Plan	setBillingPlan(?Plan billingPlan): void
experienceContext	?VaultExperienceContext	Optional	Customizes the Vault creation flow experience for your customers.	getExperienceContext(): ?VaultExperienceContext	setExperienceContext(?VaultExperienceContext experienceContext): void

Example (as JSON)

{
  "permit_multiple_payment_tokens": false,
  "description": "description0",
  "usage_pattern": "INSTALLMENT_PREPAID",
  "shipping": {
    "name": {
      "full_name": "full_name6"
    },
    "phone_number": {
      "country_code": "country_code2",
      "national_number": "national_number6"
    },
    "type": "SHIPPING",
    "address": {
      "address_line_1": "address_line_16",
      "address_line_2": "address_line_26",
      "admin_area_2": "admin_area_20",
      "admin_area_1": "admin_area_12",
      "postal_code": "postal_code8",
      "country_code": "country_code6"
    }
  },
  "usage_type": "MERCHANT"
}