On this page
No Headings
The payer information.
objectemailstringemailThe payer's email address.
first_namestringThe payer's first name.
last_namestringThe payer's last name.
payer_idstringThe PayPal-assigned ID for the payer.
shipping_addressobjectThe shipping address for a payment. Must be provided if it differs from the default address.
billing_addressobjectA simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
The payer's billing address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-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.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.