ApplePayPaymentContact
ApplePayPaymentContact Interface
This information is provided when the Apple Pay transaction includes billing or shipping contact details.
WARNING
The Apple Pay functionality is currently in a testing phase. It is only available for merchants in Chile 🇨🇱 and Peru 🇵🇪, and supports Visa and Mastercard cards.
Hierarchy
ApplePayPaymentContactProperties
| Property | Type | Description |
|---|---|---|
phoneNumber | string | User’s phone number associated with the Apple Pay contact. |
emailAddress | string | User’s email address. |
givenName | string | User’s first name. |
familyName | string | User’s last name. |
phoneticGivenName | string | User’s first name in phonetic representation. |
phoneticFamilyName | string | User’s last name in phonetic representation. |
subLocality | string | Sub-locality within the city (e.g., neighborhood or district). |
locality | string | City or locality name. |
postalCode | string | Postal or ZIP code. |
subAdministrativeArea | string | Sub-administrative region (e.g., county or district). |
administrativeArea | string | State, province, or region. |
country | string | Country name. |
countryCode | string | ISO 3166-1 alpha-2 country code. |
addressLines | string[] | Array of address lines (street name, building number, etc.). |
phoneNumber
stringDescription: User’s phone number associated with the Apple Pay billing or shipping contact.
emailAddress
stringDescription: User’s email address registered in Apple Wallet.
Defined in:
types/apple_pay_get_token_events.d.ts:20givenName
stringDescription: User’s first name.
familyName
stringDescription: User’s last name or family name.
phoneticGivenName
stringDescription: Phonetic representation of the user’s first name (used for pronunciation support).
phoneticFamilyName
stringDescription: Phonetic representation of the user’s last name.
subLocality
stringDescription: Sub-locality within a city, such as a neighborhood or district.
locality: string
stringDescription: City or locality name.
Defined in:
types/apple_pay_get_token_events.d.ts:26postalCode
stringDescription: Postal or ZIP code of the user’s address.
subAdministrativeArea
stringDescription: Sub-administrative region, such as a county or district.
administrativeArea
stringDescription: State, province, or region of the address.
country
stringDescription: Full name of the country.
countryCode
stringDescription: ISO 3166-1 alpha-2 country code (e.g.,
"US", "EC", "MX").addressLines
string[]Description: Address lines containing details like street name, number, and other descriptive address data.
Example
Modified at 2026-03-13 14:08:17