Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Person

Details of the person party.

nameobject<name>Optional

The legal name of the customer.

name properties

7 properties

prefixstringOptional

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

Length0 <= length <= 140

given_namestringOptional

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

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.

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.

Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Length0 <= length <= 140

alternate_full_namestringOptional

DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

Length0 <= length <= 300

full_namestringOptional

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

Length0 <= length <= 300

phone_contactsobject<phone_details>[]Optional

An array of contact phone numbers for the customer.

Items1 <= length <= 10

phone_details properties

2 properties

phone_number_detailsobject<phone>Required

The phone number details.

phone properties

3 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the 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,3}?$Length1 <= length <= 3

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

extension_numberstringOptional

The extension number.

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

phone_typeenum<phone_type>Required

The phone type.

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

home_addressobject<address>Optional

The home address of the account holder.

address properties

6 properties

line1stringRequired

The first line of the address. For example, number or street.

line2stringOptional

The second line of the address. For example, suite or apartment number.

citystringRequired

The city name.

statestringOptional

The [code](/docs/integration/direct/rest/state-codes/) for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: [Argentina](/docs/integration/direct/rest/state-codes/#argentina), [Brazil](/docs/integration/direct/rest/state-codes/#brazil), [Canada](/docs/integration/direct/rest/state-codes/#canada), [China](/docs/integration/direct/rest/state-codes/#china), [India](/docs/integration/direct/rest/state-codes/#india), [Italy](/docs/integration/direct/rest/state-codes/#italy), [Japan](/docs/integration/direct/rest/state-codes/#japan), [Mexico](/docs/integration/direct/rest/state-codes/#mexico), [Thailand](/docs/integration/direct/rest/state-codes/#thailand), or [United States](/docs/integration/direct/rest/state-codes/#usa). Maximum length is 40 single-byte characters.

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

nationality_country_codestring<country_code>Optional

The citizenship country code of the person

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

Back to top

Person

Details of the person party.

nameobject<name>Optional

The legal name of the customer.

name properties

7 properties

prefixstringOptional

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

Length0 <= length <= 140

given_namestringOptional

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

Length0 <= length <= 140

surnamestringOptional

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.

Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Length0 <= length <= 140

alternate_full_namestringOptional

DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

Length0 <= length <= 300

full_namestringOptional

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

Length0 <= length <= 300

phone_contactsobject<phone_details>[]Optional

An array of contact phone numbers for the customer.

Items1 <= length <= 10

phone_details properties

2 properties

phone_number_detailsobject<phone>Required

The phone number details.

phone properties

3 properties

country_codestringRequired

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

national_numberstringRequired

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

extension_numberstringOptional

The extension number.

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

phone_typeenum<phone_type>Required

The phone type.

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

home_addressobject<address>Optional

The home address of the account holder.

address properties

6 properties

line1stringRequired

The first line of the address. For example, number or street.

line2stringOptional

The second line of the address. For example, suite or apartment number.

citystringRequired

The city name.

statestringOptional

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

nationality_country_codestring<country_code>Optional

The citizenship country code of the person

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

Person

name properties

phone_details properties

phone properties

address properties

Back to top

On this page

On this page

Person

name properties

phone_details properties

phone properties

address properties

Back to top

On this page

Person

name properties

phone_details properties

phone properties

address 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

Person

name properties

phone_details properties

phone properties

address properties

Back to top

On this page