office_bearer

Schema Information

Properties

name

Type: object

The legal name of the customer.

prefix

Type: string

Max length: 140

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

given_name

Type: string

Max length: 140

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

surname

Type: string

Max length: 140

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.

middle_name

Type: string

Max length: 140

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.

suffix

Type: string

Max length: 140

The suffix for the party's name.

alternate_full_name

Type: string

Max length: 300

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.

full_name

Type: string

Max length: 300

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

phone_contacts

Type: array

An array of contact phone numbers for the customer.

Array Items

items

Type: object

The phone number and the phone type.

phone_number_detailsrequired

Type: object

The phone number details.

country_coderequired

Type: string

Pattern: ^[0-9]{1,3}?$

Min length: 1

Max length: 3

The country calling code (CC), in its canonical international E.164 numbering plan format. 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).

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

The national number, in its canonical international E.164 numbering plan format. 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).

extension_number

Type: string

Pattern: ^[0-9]{1,15}?$

Min length: 1

Max length: 15

The extension number.

phone_typerequired

Type: string

Enum: "FAX", "HOME", "MOBILE", "OTHER", "PAGER"

The phone type.

home_address

Type: object

The home address of the account holder.

line1required

Type: string

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

line2

Type: string

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

cityrequired

Type: string

The city name.

state

Type: string

The code for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: Argentina, Brazil, Canada, China, India, Italy, Japan, Mexico, Thailand, or United States. Maximum length is 40 single-byte characters.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO 3166-1 code 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.

postal_code

Type: string

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

nationality_country_code

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The citizenship country code of the person

role

Type: string

Enum: "CEO", "CHAIRMAN", "DIRECTOR", "SECRETARY", "TREASURER", "TRUSTEE"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The role of the person in the company.

Properties

name

Type: object

The legal name of the customer.

prefix

Type: string

Max length: 140

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

given_name

Type: string

Max length: 140

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

surname

Type: string

Max length: 140

middle_name

Type: string

Max length: 140

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.

suffix

Type: string

Max length: 140

The suffix for the party's name.

alternate_full_name

Type: string

Max length: 300

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.

full_name

Type: string

Max length: 300

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

phone_contacts

Type: array

An array of contact phone numbers for the customer.

Array Items

items

Type: object

The phone number and the phone type.

phone_number_detailsrequired

Type: object

The phone number details.

country_coderequired

Type: string

Pattern: ^[0-9]{1,3}?$

Min length: 1

Max length: 3

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

extension_number

Type: string

Pattern: ^[0-9]{1,15}?$

Min length: 1

Max length: 15

The extension number.

phone_typerequired

Type: string

Enum: "FAX", "HOME", "MOBILE", "OTHER", "PAGER"

The phone type.

home_address

Type: object

The home address of the account holder.

line1required

Type: string

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

line2

Type: string

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

cityrequired

Type: string

The city name.

state

Type: string

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO 3166-1 code 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.

postal_code

Type: string

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

nationality_country_code

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The citizenship country code of the person

role

Type: string

Enum: "CEO", "CHAIRMAN", "DIRECTOR", "SECRETARY", "TREASURER", "TRUSTEE"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The role of the person in the company.

office_bearer

Schema Information

Properties

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

office_bearer

Schema Information

Properties