Venmo Experience Context

November 13, 2025 ยท View on GitHub

A resource representing an experience context of vault a venmo account.

Structure

VenmoExperienceContext

Fields

NameTypeTagsDescriptionGetterSetter
BrandNameStringOptionalThe 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: ^.*$
String getBrandName()setBrandName(String brandName)
ShippingPreferenceExperienceContextShippingPreferenceOptionalThe 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_]+$
ExperienceContextShippingPreference getShippingPreference()setShippingPreference(ExperienceContextShippingPreference shippingPreference)
VaultInstructionVaultInstructionActionOptionalDEPRECATED. Vault Instruction on action to be performed after a successful payer approval.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$
VaultInstructionAction getVaultInstruction()setVaultInstruction(VaultInstructionAction vaultInstruction)
UserActionVaultUserActionOptionalUser Action on action to be performed after a successful payer approval.

Default: VaultUserAction.CONTINUE

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$
VaultUserAction getUserAction()setUserAction(VaultUserAction userAction)

Example (as JSON)

{
  "shipping_preference": "GET_FROM_FILE",
  "user_action": "CONTINUE",
  "brand_name": "brand_name0",
  "vault_instruction": "ON_CREATE_PAYMENT_TOKENS"
}