PayPal Wallet Request

A resource representing a request to vault PayPal Wallet.

descriptionstringOptional

The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.

Match^.*$Length1 <= length <= 128

usage_patternenum<usage_pattern>Optional

Expected business/charge model for the billing agreement.

Match^[0-9A-Z_]+$Length1 <= length <= 30

Allowed values

"IMMEDIATE"
"DEFERRED"
"RECURRING_PREPAID"
"RECURRING_POSTPAID"
"THRESHOLD_PREPAID"
"THRESHOLD_POSTPAID"
"UNSCHEDULED_POSTPAID"
"UNSCHEDULED_PREPAID"
"SUBSCRIPTION_PREPAID"
"SUBSCRIPTION_POSTPAID"
"INSTALLMENT_POSTPAID"
"INSTALLMENT_PREPAID"

shippingobject<Shipping Details>Optional

The shipping details.

Shipping Details properties

5 properties

email_addressstring<email_address>Optional

The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.

Match^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$Formatppaas_common_email_address_v2Length3 <= length <= 254

phone_numberobject<Phone>Optional

The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

typeenumOptional

A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"SHIPPING"
"PICKUP_IN_PERSON"
"PICKUP_IN_STORE"
"PICKUP_FROM_PERSON"

addressobject<Portable Postal Address (Medium-Grained)>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

permit_multiple_payment_tokensbooleanOptional

Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.

Defaultfalse

experience_contextobject<paypal_wallet_experience_context>Optional

A resource representing an experience context of vault PayPal Wallet.

paypal_wallet_experience_context properties

8 properties

brand_namestringOptional

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.

Match^.*$Length1 <= length <= 127

localestring<language>Optional

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`.

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Formatppaas_common_language_v3Length2 <= length <= 10

return_urlstringOptional

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.

FormaturiLength1 <= length <= 4000

cancel_urlstringOptional

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.

FormaturiLength1 <= length <= 4000

shipping_preferenceenumOptional

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

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"GET_FROM_FILE"Default
"NO_SHIPPING"
"SET_PROVIDED_ADDRESS"

vault_instructionenum<vault_instruction>OptionalDeprecated

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

Match^[A-Z_]+$Length1 <= length <= 255

Allowed values

"ON_CREATE_PAYMENT_TOKENS"Default
"ON_PAYER_APPROVAL"

app_switch_contextobject<app_switch_context>Optional

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

user_actionenum<user_action>Optional

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

Match^[A-Z_]+$Length1 <= length <= 255

Allowed values

"SETUP_NOW"
"CONTINUE"Default

A resource representing a request to vault PayPal Wallet.

descriptionstringOptional

The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.

Match^.*$Length1 <= length <= 128

usage_patternenum<usage_pattern>Optional

Expected business/charge model for the billing agreement.

Match^[0-9A-Z_]+$Length1 <= length <= 30

Allowed values

"IMMEDIATE"
"DEFERRED"
"RECURRING_PREPAID"
"RECURRING_POSTPAID"
"THRESHOLD_PREPAID"
"THRESHOLD_POSTPAID"
"UNSCHEDULED_POSTPAID"
"UNSCHEDULED_PREPAID"
"SUBSCRIPTION_PREPAID"
"SUBSCRIPTION_POSTPAID"
"INSTALLMENT_POSTPAID"
"INSTALLMENT_PREPAID"

shippingobject<Shipping Details>Optional

The shipping details.

Shipping Details properties

5 properties

email_addressstring<email_address>Optional

The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.

phone_numberobject<Phone>Optional

The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

typeenumOptional

A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"SHIPPING"
"PICKUP_IN_PERSON"
"PICKUP_IN_STORE"
"PICKUP_FROM_PERSON"

addressobject<Portable Postal Address (Medium-Grained)>Optional

permit_multiple_payment_tokensbooleanOptional

Defaultfalse

experience_contextobject<paypal_wallet_experience_context>Optional

A resource representing an experience context of vault PayPal Wallet.

paypal_wallet_experience_context properties

8 properties

brand_namestringOptional

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.

Match^.*$Length1 <= length <= 127

localestring<language>Optional

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Formatppaas_common_language_v3Length2 <= length <= 10

return_urlstringOptional

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.

FormaturiLength1 <= length <= 4000

cancel_urlstringOptional

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.

FormaturiLength1 <= length <= 4000

shipping_preferenceenumOptional

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

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"GET_FROM_FILE"Default
"NO_SHIPPING"
"SET_PROVIDED_ADDRESS"

vault_instructionenum<vault_instruction>OptionalDeprecated

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

Match^[A-Z_]+$Length1 <= length <= 255

Allowed values

"ON_CREATE_PAYMENT_TOKENS"Default
"ON_PAYER_APPROVAL"

app_switch_contextobject<app_switch_context>Optional

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

user_actionenum<user_action>Optional

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

Match^[A-Z_]+$Length1 <= length <= 255

Allowed values

"SETUP_NOW"
"CONTINUE"Default

PayPal Wallet Request

Shipping Details properties

Name properties

Phone properties

Portable Postal Address (Medium-Grained) properties

plan properties

billing_cycle properties

pricing_scheme properties

money properties

money properties

one_time_charges properties

money properties

money properties

money properties

money properties

money properties

money properties

paypal_wallet_experience_context properties

app_switch_context properties

native_app_context properties

mobile_web_context properties

Back to top

On this page

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

PayPal Wallet Request

Shipping Details properties

Name properties

Phone properties

Portable Postal Address (Medium-Grained) properties

plan properties

billing_cycle properties

pricing_scheme properties

money properties

money properties

one_time_charges properties

money properties

money properties

money properties

money properties

money properties

money properties

paypal_wallet_experience_context properties

app_switch_context properties

native_app_context properties

mobile_web_context properties

Back to top

On this page