Customer Information
May 27, 2025 · View on GitHub
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
Structure
CustomerInformation
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
Id | String | Optional | The unique ID for a customer generated by PayPal. Constraints: Minimum Length: 1, Maximum Length: 22, Pattern: ^[0-9a-zA-Z_-]+$ | String getId() | setId(String id) |
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: (?:[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])+)\]) | String getEmailAddress() | setEmailAddress(String emailAddress) |
Phone | PhoneWithType | Optional | The phone information. | PhoneWithType getPhone() | setPhone(PhoneWithType phone) |
Name | Name | Optional | The name of the party. | Name getName() | setName(Name name) |
Example (as JSON)
{
"id": "id6",
"email_address": "email_address4",
"phone": {
"phone_type": "OTHER",
"phone_number": {
"national_number": "national_number6"
}
},
"name": {
"given_name": "given_name2",
"surname": "surname8"
}
}