Card Experience Context

A resource representing an experience context of vault a card.

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.

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.

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.

A resource representing an experience context of vault a card.

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

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.

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.

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.

Card Experience Context

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Card Experience Context

Schema Information

Properties