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

merchant_customer_idstringOptional

Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Match^[0-9a-zA-Z-_.^*$@#]+$Length1 <= length <= 64

vaultobject<vault_instruction_base>Optional

Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.

vault_instruction_base properties

1 property

store_in_vaultenum<store_in_vault_instruction>Optional

Defines how and when the payment source gets vaulted.

Value in"ON_SUCCESS"

verificationobject<card_verification>Optional

The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).

card_verification properties

1 property

methodenumOptional

The method used for card verification.

Default"SCA_WHEN_REQUIRED"Value in"SCA_ALWAYS" | "SCA_WHEN_REQUIRED" | "3D_SECURE" | "AVS_CVV"

Back to top

card_attributes

Additional attributes associated with the use of this card.

customerobject<card_customer>Optional

The details about a customer in PayPal's system of record.

card_customer properties

5 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

merchant_customer_idstringOptional

Match^[0-9a-zA-Z-_.^*$@#]+$Length1 <= length <= 64

vaultobject<vault_instruction_base>Optional

Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.

vault_instruction_base properties

1 property

store_in_vaultenum<store_in_vault_instruction>Optional

Defines how and when the payment source gets vaulted.

Value in"ON_SUCCESS"

verificationobject<card_verification>Optional

The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).

card_verification properties

1 property

methodenumOptional

The method used for card verification.

Default"SCA_WHEN_REQUIRED"Value in"SCA_ALWAYS" | "SCA_WHEN_REQUIRED" | "3D_SECURE" | "AVS_CVV"

card_attributes

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

Back to top

On this page

On this page

card_attributes

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

Back to top

On this page

card_attributes

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

Back to top

On this page

On this page

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

card_attributes

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

Back to top

On this page