Venmo Wallet Experience Context

August 21, 2026 ยท View on GitHub

Customizes the buyer experience during the approval process for payment with Venmo. Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.

Structure

VenmoWalletExperienceContext

Fields

NameTypeTagsDescriptionGetterSetter
BrandNameStringOptionalThe business name of the merchant. The pattern is defined by an external party and supports Unicode.

Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^.*$
String getBrandName()setBrandName(String brandName)
ShippingPreferenceVenmoWalletExperienceContextShippingPreferenceOptionalThe location from which the shipping address is derived.

Default: VenmoWalletExperienceContextShippingPreference.GET_FROM_FILE

Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$
VenmoWalletExperienceContextShippingPreference getShippingPreference()setShippingPreference(VenmoWalletExperienceContextShippingPreference shippingPreference)
OrderUpdateCallbackConfigCallbackConfigurationOptionalCallBack Configuration that the merchant can provide to PayPal/Venmo.CallbackConfiguration getOrderUpdateCallbackConfig()setOrderUpdateCallbackConfig(CallbackConfiguration orderUpdateCallbackConfig)
UserActionVenmoWalletExperienceContextUserActionOptionalConfigures a Continue or Pay Now checkout flow.

Default: VenmoWalletExperienceContextUserAction.CONTINUE

Constraints: Minimum Length: 1, Maximum Length: 8, Pattern: ^[0-9A-Z_]+$
VenmoWalletExperienceContextUserAction getUserAction()setUserAction(VenmoWalletExperienceContextUserAction userAction)

Example

import com.paypal.sdk.models.CallbackConfiguration;
import com.paypal.sdk.models.CallbackEvents;
import com.paypal.sdk.models.VenmoWalletExperienceContext;
import com.paypal.sdk.models.VenmoWalletExperienceContextShippingPreference;
import com.paypal.sdk.models.VenmoWalletExperienceContextUserAction;
import java.util.Arrays;

VenmoWalletExperienceContext venmoWalletExperienceContext = new VenmoWalletExperienceContext.Builder()
    .brandName("brand_name8")
    .shippingPreference(VenmoWalletExperienceContextShippingPreference.GET_FROM_FILE)
    .orderUpdateCallbackConfig(new CallbackConfiguration.Builder(
        Arrays.asList(
            CallbackEvents.SHIPPING_OPTIONS,
            CallbackEvents.SHIPPING_ADDRESS,
            CallbackEvents.SHIPPING_OPTIONS
        ),
        "callback_url6"
    )
    .build())
    .userAction(VenmoWalletExperienceContextUserAction.CONTINUE)
    .build();