On this page
No Headings
The shipping address details.
line1requiredstringThe first line of the address. For example, number, street, and so on.
line2stringThe second line of the address. For example, suite or apartment number.
citystringThe city name.
country_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.
statestringnormalization_statusstring"UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"The address normalization status. Returned only for payers from Brazil.
typestringThe type of address. For example, HOME_OR_WORK, GIFT, and so on.
recipient_namestringThe name of the recipient at this address.