Card Customer Information

August 21, 2026 ยท View on GitHub

The details about a customer in PayPal's system of record.

Structure

CardCustomerInformation

Fields

NameTypeTagsDescriptionGetterSetter
IdStringOptionalThe 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)
EmailAddressStringOptionalThe 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)
PhonePhoneWithTypeOptionalThe phone information.PhoneWithType getPhone()setPhone(PhoneWithType phone)
NameNameOptionalThe name of the party.Name getName()setName(Name name)
MerchantCustomerIdStringOptionalMerchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Constraints: Minimum Length: 1, Maximum Length: 64, Pattern: ^[0-9a-zA-Z-_.^*$@#]+$
String getMerchantCustomerId()setMerchantCustomerId(String merchantCustomerId)

Example

import com.paypal.sdk.models.CardCustomerInformation;
import com.paypal.sdk.models.Name;
import com.paypal.sdk.models.PhoneNumber;
import com.paypal.sdk.models.PhoneType;
import com.paypal.sdk.models.PhoneWithType;

CardCustomerInformation cardCustomerInformation = new CardCustomerInformation.Builder()
    .id("id0")
    .emailAddress("email_address8")
    .phone(new PhoneWithType.Builder(
        new PhoneNumber.Builder(
            "national_number6"
        )
        .build()
    )
    .phoneType(PhoneType.OTHER)
    .build())
    .name(new Name.Builder()
        .givenName("given_name2")
        .surname("surname8")
        .build())
    .merchantCustomerId("merchant_customer_id2")
    .build();