PayPal-PHP-Server-SDK/doc/models/vault-experience-context.md

Vault Experience Context

Customizes the Vault creation flow experience for your customers.

Structure

VaultExperienceContext

Fields

Name	Type	Tags	Description	Getter	Setter
brandName	?string	Optional	The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^.*$	getBrandName(): ?string	setBrandName(?string brandName): void
locale	?string	Optional	The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code. Constraints: Minimum Length: 2, Maximum Length: 10, Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$	getLocale(): ?string	setLocale(?string locale): void
returnUrl	?string	Optional	The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. Constraints: Minimum Length: 1, Maximum Length: 4000	getReturnUrl(): ?string	setReturnUrl(?string returnUrl): void
cancelUrl	?string	Optional	The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. Constraints: Minimum Length: 1, Maximum Length: 4000	getCancelUrl(): ?string	setCancelUrl(?string cancelUrl): void
shippingPreference	?string(ExperienceContextShippingPreference)	Optional	The shipping preference. This only applies to PayPal payment source. Default: ExperienceContextShippingPreference::GET_FROM_FILE Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getShippingPreference(): ?string	setShippingPreference(?string shippingPreference): void
vaultInstruction	?string(VaultInstructionAction)	Optional	DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$	getVaultInstruction(): ?string	setVaultInstruction(?string vaultInstruction): void
appSwitchContext	?AppSwitchContext	Optional	Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.	getAppSwitchContext(): ?AppSwitchContext	setAppSwitchContext(?AppSwitchContext appSwitchContext): void
userAction	?string(VaultUserAction)	Optional	User Action on action to be performed after a successful payer approval. Default: VaultUserAction::CONTINUE_ Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$	getUserAction(): ?string	setUserAction(?string userAction): void

Example (as JSON)

{
  "shipping_preference": "GET_FROM_FILE",
  "user_action": "CONTINUE",
  "brand_name": "brand_name0",
  "locale": "locale4",
  "return_url": "return_url2",
  "cancel_url": "cancel_url4"
}