On this page
No Headings
The customer who approves and pays for the order. The customer is also known as the payer.
objectemail_addressobject^.*(?:[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])+)\]).*$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.
The email address of the payer.
payer_idobject^[2-9A-HJ-NP-Z]{13}$The account identifier for a PayPal account.
The PayPal-assigned ID for the payer.
nameobjectThe name of the party.
The name of the payer. Supports only the given_name and surname properties.
prefixstring^[\S\s]*$The prefix, or title, to the party's name.
given_namestring^[\S\s]*$When the party is a person, the party's given, or first, name.
surnamestring^[\S\s]*$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_namestring^[\S\s]*$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.
suffixstring^[\S\s]*$The suffix for the party's name.
full_namestring^[\S\s]*$When the party is a person, the party's full name.
phoneobjectThe phone information.
The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.
phone_typestring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
phone_numberrequiredobjectA structured representation of a phone number conforming to the international E.164 numbering plan format,requiring only the national_number field.
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.
national_numberrequiredstring^[0-9]{1,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).
birth_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The birth date of the payer in YYYY-MM-DD format.
tax_infoobjectThe tax ID of the customer. The customer is also known as the payer. Both tax_id and tax_id_type are required.
The tax information of the payer. Required only for Brazilian payer's. Both tax_id and tax_id_type are required.
tax_idrequiredstring^.*([a-zA-Z0-9]).*$The customer's tax ID value.
tax_id_typerequiredstring"BR_CPF", "BR_CNPJ"The customer's tax ID type.
addressobjectThe portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.
address_line_1string^[\S\s]*$The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.
address_line_2string^[\S\s]*$The second line of the address, for example, a suite or apartment number.
address_line_3string^[\S\s]*$The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4string^[\S\s]*$The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3string^[\S\s]*$The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:
admin_area_2string^[\S\s]*$A city, town, or village. Smaller than admin_area_level_1.
admin_area_1string^[\S\s]*$The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
postal_codestring^[\S\s]*$The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstring^([A-Z]{2}|C2)$The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobjectThe non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
street_numberstring^[\S\s]*$The street number.
street_namestring^[\S\s]*$The street name. Just Drury in Drury Lane.
street_typestring^[\S\s]*$The street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestring^[\S\s]*$The delivery service. Post office box, bag number, or post office name.
building_namestring^[\S\s]*$A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstring^[\S\s]*$The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.