Payer Information

The payer information.

account_idstringOptional

The PayPal` customer account ID.

Match^[a-zA-Z0-9_]*$Length1 <= length <= 13

email_addressstring<email_address>Optional

The email address of the payer.

Match^.+@[^"\-].+$Formatppaas_common_email_address_v2Length3 <= length <= 254

phone_numberobject<phone>Optional

The primary phone number of the payer.

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

address_statusstringOptional

The address status of the payer. Value is either:

Y. Verified.
N. Not verified.

Match^[N|Y]$Length1 <= length <= 1

payer_statusstringOptional

The status of the payer. Value is `Y` or `N`.

Match^[N|Y]$Length1 <= length <= 1

payer_nameobject<name>Optional

The payer name.

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

country_codestring<country_code>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region of the payer.

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

addressobject<address>Optional

The payer address.

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](/api/rest/reference/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](/api/rest/reference/state-codes/#argentina), [Brazil](/api/rest/reference/state-codes/#brazil), [Canada](/api/rest/reference/state-codes/#canada), [China](/api/rest/reference/state-codes/#china), [India](/api/rest/reference/state-codes/#india), [Italy](/api/rest/reference/state-codes/#italy), [Japan](/api/rest/reference/state-codes/#japan), [Mexico](/api/rest/reference/state-codes/#mexico), [Thailand](/api/rest/reference/state-codes/#thailand), or [United States](/api/rest/reference/state-codes/#usa). Maximum length is 40 single-byte characters.

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/api/rest/reference/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).

The payer information.

account_idstringOptional

The PayPal` customer account ID.

Match^[a-zA-Z0-9_]*$Length1 <= length <= 13

email_addressstring<email_address>Optional

The email address of the payer.

Match^.+@[^"\-].+$Formatppaas_common_email_address_v2Length3 <= length <= 254

phone_numberobject<phone>Optional

The primary phone number of the payer.

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

address_statusstringOptional

The address status of the payer. Value is either:

Y. Verified.
N. Not verified.

Match^[N|Y]$Length1 <= length <= 1

payer_statusstringOptional

The status of the payer. Value is `Y` or `N`.

Match^[N|Y]$Length1 <= length <= 1

payer_nameobject<name>Optional

The payer name.

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

country_codestring<country_code>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region of the payer.

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

addressobject<address>Optional

The payer address.

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](/api/rest/reference/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).

Payer Information

phone properties

name properties

address properties

Back to top

On this page

On this page

Payer Information

phone properties

name properties

address properties

Back to top

On this page

Payer Information

phone properties

name properties

address properties

Back to top

On this page

On this page

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

Payer Information

phone properties

name properties

address properties

Back to top

On this page