Payer Information

The payer information.

Schema Information

Type:object

Properties

email

Type: string

Format: email

The payer's email address. Maximum length is 127 characters.

salutation

Type: string

The payer's salutation.

first_name

Type: string

The payer's first name.

middle_name

Type: string

The payer's middle name.

last_name

Type: string

The payer's last name.

suffix

Type: string

The payer's suffix.

payer_id

Type: string

The PayPal-assigned encrypted payer ID.

birth_date

Type: string

Format: date-time

The birth date of the payer, in Internet date format. For example, 1990-04-12.

tax_id

Type: string

Max length: 14

The payer's tax ID. Supported for the PayPal payment method only.

tax_id_type

Type: string

Enum: "BR_CPF", "BR_CNPJ"

The payer's tax ID type. Supported for the PayPal payment method only.

billing_address

Type: object

The payer's billing address.

line1required

Type: string

Max length: 300

The first line of the address. For example, number, street, and so on.

line2

Type: string

Max length: 300

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

city

Type: string

Max length: 64

The city name.

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.

state

Type: string

Max length: 300

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.

phone

Type: string

Format: phone

The phone number, in E.123 format. Maximum length is 50 characters.

normalization_status

Type: string

Enum: "UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"

The address normalization status. Returned only for payers from Brazil.

type

Type: string

The type of address. For example, HOME_OR_WORK, GIFT, and so on.

shipping_address

Type: object

Deprecated. The shipping address. Use the shipping address for the purchase unit or at the root level of the checkout session.

line1required

Type: string

Max length: 300

The first line of the address. For example, number, street, and so on.

line2

Type: string

Max length: 300

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

city

Type: string

Max length: 64

The city name.

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.

state

Type: string

Max length: 300

phone

Type: string

Format: phone

The phone number, in E.123 format. Maximum length is 50 characters.

normalization_status

Type: string

Enum: "UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"

The address normalization status. Returned only for payers from Brazil.

type

Type: string

The type of address. For example, HOME_OR_WORK, GIFT, and so on.

recipient_name

Type: string

Max length: 127

The name of the recipient at this address.

Properties

email

Type: string

Format: email

The payer's email address. Maximum length is 127 characters.

salutation

Type: string

The payer's salutation.

first_name

Type: string

The payer's first name.

middle_name

Type: string

The payer's middle name.

last_name

Type: string

The payer's last name.

suffix

Type: string

The payer's suffix.

payer_id

Type: string

The PayPal-assigned encrypted payer ID.

birth_date

Type: string

Format: date-time

The birth date of the payer, in Internet date format. For example, 1990-04-12.

tax_id

Type: string

Max length: 14

The payer's tax ID. Supported for the PayPal payment method only.

tax_id_type

Type: string

Enum: "BR_CPF", "BR_CNPJ"

The payer's tax ID type. Supported for the PayPal payment method only.

billing_address

Type: object

The payer's billing address.

line1required

Type: string

Max length: 300

The first line of the address. For example, number, street, and so on.

line2

Type: string

Max length: 300

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

city

Type: string

Max length: 64

The city name.

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.

state

Type: string

Max length: 300

phone

Type: string

Format: phone

The phone number, in E.123 format. Maximum length is 50 characters.

normalization_status

Type: string

Enum: "UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"

The address normalization status. Returned only for payers from Brazil.

type

Type: string

The type of address. For example, HOME_OR_WORK, GIFT, and so on.

shipping_address

Type: object

Deprecated. The shipping address. Use the shipping address for the purchase unit or at the root level of the checkout session.

line1required

Type: string

Max length: 300

The first line of the address. For example, number, street, and so on.

line2

Type: string

Max length: 300

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

city

Type: string

Max length: 64

The city name.

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.

state

Type: string

Max length: 300

phone

Type: string

Format: phone

The phone number, in E.123 format. Maximum length is 50 characters.

normalization_status

Type: string

Enum: "UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"

The address normalization status. Returned only for payers from Brazil.

type

Type: string

The type of address. For example, HOME_OR_WORK, GIFT, and so on.

recipient_name

Type: string

Max length: 127

The name of the recipient at this address.

Payer Information

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

Payer Information

Schema Information

Properties