PayPal-PHP-Server-SDK/doc/models/payer-information.md

Payer Information

The payer information.

Structure

PayerInformation

Fields

Name	Type	Tags	Description	Getter	Setter
accountId	?string	Optional	The PayPalcustomer account ID.<br><br>**Constraints**: *Minimum Length*:1, *Maximum Length*: 13, *Pattern*: ^[a-zA-Z0-9]*$`	getAccountId(): ?string	setAccountId(?string accountId): void
emailAddress	?string	Optional	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. Constraints: Minimum Length: 3, Maximum Length: 254, Pattern: ^.+@[^"\-].+$	getEmailAddress(): ?string	setEmailAddress(?string emailAddress): void
phoneNumber	?Phone	Optional	The phone number, in its canonical international E.164 numbering plan format.	getPhoneNumber(): ?Phone	setPhoneNumber(?Phone phoneNumber): void
addressStatus	?string	Optional	The address status of the payer. Value is either: Y. Verified. N. Not verified. Constraints: Minimum Length: 1, Maximum Length: 1, Pattern: ^[N|Y]$	getAddressStatus(): ?string	setAddressStatus(?string addressStatus): void
payerStatus	?string	Optional	The status of the payer. Value is Y or N. Constraints: Minimum Length: 1, Maximum Length: 1, Pattern: ^[N|Y]$	getPayerStatus(): ?string	setPayerStatus(?string payerStatus): void
payerName	?PayerName	Optional	The name of the party.	getPayerName(): ?PayerName	setPayerName(?PayerName payerName): void
countryCode	?string	Optional	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. Constraints: Minimum Length: 2, Maximum Length: 2, Pattern: ^([A-Z]{2}|C2)$	getCountryCode(): ?string	setCountryCode(?string countryCode): void
address	?SimplePostalAddressCoarseGrained	Optional	A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.	getAddress(): ?SimplePostalAddressCoarseGrained	setAddress(?SimplePostalAddressCoarseGrained address): void

Example (as JSON)

{
  "account_id": "account_id6",
  "email_address": "email_address2",
  "phone_number": {
    "country_code": "country_code2",
    "national_number": "national_number6",
    "extension_number": "extension_number8"
  },
  "address_status": "address_status2",
  "payer_status": "payer_status8"
}