ApplePayPaymentContact Interface

Represents the shipping or billing contact data of the user configured in their Apple Wallet.
This information is provided when the Apple Pay transaction includes billing or shipping contact details.

Watch Out!
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.
Please note that this functionality is subject to change without prior notice.

Hierarchy

ApplePayPaymentContact

Properties

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

Type: string
Description: User’s phone number associated with the Apple Pay billing or shipping contact.

emailAddress

Type: string
Description: User’s email address registered in Apple Wallet.
Defined in: types/apple_pay_get_token_events.d.ts:20

givenName

Type: string
Description: User’s first name.

familyName

Type: string
Description: User’s last name or family name.

phoneticGivenName

Type: string
Description: Phonetic representation of the user’s first name (used for pronunciation support).

phoneticFamilyName

Type: string
Description: Phonetic representation of the user’s last name.

subLocality

Type: string
Description: Sub-locality within a city, such as a neighborhood or district.

`locality: string`

Type: string
Description: City or locality name.
Defined in: types/apple_pay_get_token_events.d.ts:26

postalCode

Type: string
Description: Postal or ZIP code of the user’s address.

subAdministrativeArea

Type: string
Description: Sub-administrative region, such as a county or district.

administrativeArea

Type: string
Description: State, province, or region of the address.

country

Type: string
Description: Full name of the country.

countryCode

Type: string
Description: ISO 3166-1 alpha-2 country code (e.g., "US", "EC", "MX").

addressLines

Type: string[]
Description: Address lines containing details like street name, number, and other descriptive address data.

Example

const billingContact: ApplePayPaymentContact = {
  givenName: "John",
  familyName: "Doe",
  emailAddress: "john.doe@example.com",
  phoneNumber: "+15555555555",
  addressLines: ["123 Main St", "Apt 4B"],
  locality: "Quito",
  administrativeArea: "Pichincha",
  postalCode: "170102",
  country: "Ecuador",
  countryCode: "EC",
};

Watch Out!#

Hierarchy#

Properties#

phoneNumber#

emailAddress#

givenName#

familyName#

phoneticGivenName#

phoneticFamilyName#

subLocality#

locality: string#

postalCode#

subAdministrativeArea#

administrativeArea#

country#

countryCode#

addressLines#

Example#

Watch Out!