Experience Context

Customizes the Vault creation flow experience for your customers.

Schema Information

Type:object

Properties

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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.

locale

Type: string

Format: ppaas_common_language_v3

Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$

Min length: 2

Max length: 10

The BCP 47-formatted locale of pages that the PayPal vaulting experience shows. PayPal supports a five-character code. For example, DA-DK, HE-IL, ID-ID, JA-JP, NO-NO, PT-BR, RU-RU, SV-SE, TH-TH, ZH-CN, ZH-HK, or ZH-TW.

return_url

Type: string

Format: uri

Min length: 1

Max length: 4000

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.

cancel_url

Type: string

Format: uri

Min length: 1

Max length: 4000

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.

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "GET_FROM_FILE"

The shipping preference. This only applies to PayPal payment source.

vault_instruction

Type: string

Enum: "ON_CREATE_PAYMENT_TOKENS", "ON_PAYER_APPROVAL"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "ON_CREATE_PAYMENT_TOKENS"

DEPRECATED. Vault Instruction on action to be performed after a successful payer approval.

app_switch_context

Type: object

Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.

native_app

Type: object

Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.

os_type

Type: string

Enum: "ANDROID", "IOS", "OTHER"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 7

Operating System type of the device that the buyer is using.

os_version

Type: string

Pattern: ^.*$

Min length: 1

Max length: 64

Operating System version of the device that the buyer is using.

mobile_web

Type: object

Buyer's mobile web browser context to app switch to the PayPal consumer app.

return_flow

Type: string

Enum: "AUTO", "MANUAL"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 6

Default: "AUTO"

Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.

buyer_user_agent

Type: string

Pattern: ^.*$

Min length: 1

Max length: 512

User agent from the request originating from the buyer's device. This will be used to identify the buyer's operating system and browser versions. NOTE: Merchants must not alter or modify the buyer's device user agent.

user_action

Type: string

Enum: "SETUP_NOW", "CONTINUE"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "CONTINUE"

User Action on action to be performed after a successful payer approval.

Properties

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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.

locale

Type: string

Format: ppaas_common_language_v3

Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$

Min length: 2

Max length: 10

return_url

Type: string

Format: uri

Min length: 1

Max length: 4000

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.

cancel_url

Type: string

Format: uri

Min length: 1

Max length: 4000

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.

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "GET_FROM_FILE"

The shipping preference. This only applies to PayPal payment source.

vault_instruction

Type: string

Enum: "ON_CREATE_PAYMENT_TOKENS", "ON_PAYER_APPROVAL"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "ON_CREATE_PAYMENT_TOKENS"

DEPRECATED. Vault Instruction on action to be performed after a successful payer approval.

app_switch_context

Type: object

Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.

native_app

Type: object

Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.

os_type

Type: string

Enum: "ANDROID", "IOS", "OTHER"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 7

Operating System type of the device that the buyer is using.

os_version

Type: string

Pattern: ^.*$

Min length: 1

Max length: 64

Operating System version of the device that the buyer is using.

mobile_web

Type: object

Buyer's mobile web browser context to app switch to the PayPal consumer app.

return_flow

Type: string

Enum: "AUTO", "MANUAL"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 6

Default: "AUTO"

Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.

buyer_user_agent

Type: string

Pattern: ^.*$

Min length: 1

Max length: 512

user_action

Type: string

Enum: "SETUP_NOW", "CONTINUE"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "CONTINUE"

User Action on action to be performed after a successful payer approval.

Experience Context

Schema Information

Properties

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Experience Context

Schema Information

Properties