Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

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])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-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])+)\]).*$Length3 <= length <= 254

phoneobject<phone_with_type>Optional

The phone information.

phone_with_type properties

2 properties

phone_typeenum<phone_type>Optional

The phone type.

Value in"FAX" | "HOME" | "MOBILE" | "OTHER" | "PAGER"

phone_numberobject<phone_number_without_country_code>Required

A structured representation of a phone number conforming to the international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en),requiring only the national_number field.

phone_number_without_country_code properties

1 property

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,14}?$Length1 <= length <= 14

nameobject<name>Optional

The name of the party.

name properties

6 properties

prefixstringOptional

The prefix, or title, to the party's name.

Match^[\S\s]*$Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Match^[\S\s]*$Length0 <= length <= 140

surnamestringOptional

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Match^[\S\s]*$Length0 <= length <= 140

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Match^[\S\s]*$Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Match^[\S\s]*$Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Match^[\S\s]*$Length0 <= length <= 300

vaultobject<vault_venmo_wallet_base>Optional

Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.

vault_venmo_wallet_base properties

6 properties

store_in_vaultenum<store_in_vault_instruction>Required

Defines how and when the payment source gets vaulted.

Value in"ON_SUCCESS"

descriptionstringOptional

The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.

Match^[a-zA-Z0-9_'\-., :;\!?"]*$Length1 <= length <= 128

usage_patternenumOptional

Expected business/pricing model for the billing agreement.

usage_typeenumRequired

The usage type associated with the Venmo payment token.

Value in"MERCHANT" | "PLATFORM"

customer_typeenumOptional

The customer type associated with the Venmo payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

Default"CONSUMER"Value in"CONSUMER" | "BUSINESS"

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 Venmo account.

Defaultfalse

Back to top

venmo_wallet_attributes

Additional attributes associated with the use of this Venmo Wallet.

customerobject<venmo_wallet_customer>Optional

This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.

venmo_wallet_customer properties

4 properties

idstring<merchant_partner_customer_id>Optional

The unique ID for a customer generated by PayPal.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 22

email_addressstring<email>Optional

The internationalized email address.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

phoneobject<phone_with_type>Optional

The phone information.

phone_with_type properties

2 properties

phone_typeenum<phone_type>Optional

The phone type.

Value in"FAX" | "HOME" | "MOBILE" | "OTHER" | "PAGER"

phone_numberobject<phone_number_without_country_code>Required

A structured representation of a phone number conforming to the international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en),requiring only the national_number field.

phone_number_without_country_code properties

1 property

national_numberstringRequired

Match^[0-9]{1,14}?$Length1 <= length <= 14

nameobject<name>Optional

The name of the party.

name properties

6 properties

prefixstringOptional

The prefix, or title, to the party's name.

Match^[\S\s]*$Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Match^[\S\s]*$Length0 <= length <= 140

surnamestringOptional

Match^[\S\s]*$Length0 <= length <= 140

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Match^[\S\s]*$Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Match^[\S\s]*$Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Match^[\S\s]*$Length0 <= length <= 300

vaultobject<vault_venmo_wallet_base>Optional

Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.

vault_venmo_wallet_base properties

6 properties

store_in_vaultenum<store_in_vault_instruction>Required

Defines how and when the payment source gets vaulted.

Value in"ON_SUCCESS"

descriptionstringOptional

The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.

Match^[a-zA-Z0-9_'\-., :;\!?"]*$Length1 <= length <= 128

usage_patternenumOptional

Expected business/pricing model for the billing agreement.

usage_typeenumRequired

The usage type associated with the Venmo payment token.

Value in"MERCHANT" | "PLATFORM"

customer_typeenumOptional

The customer type associated with the Venmo payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

Default"CONSUMER"Value in"CONSUMER" | "BUSINESS"

permit_multiple_payment_tokensbooleanOptional

Defaultfalse

venmo_wallet_attributes

venmo_wallet_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_venmo_wallet_base properties

Back to top

On this page

On this page

venmo_wallet_attributes

venmo_wallet_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_venmo_wallet_base properties

Back to top

On this page

venmo_wallet_attributes

venmo_wallet_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_venmo_wallet_base 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

venmo_wallet_attributes

venmo_wallet_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_venmo_wallet_base properties

Back to top

On this page