Contents

ApplePayErrorContactField

Names of the fields in the shipping or billing contact information, used to locate errors in the payment sheet.

Declaration

enum ApplePayErrorContactField

Overview

When shipping or billing contact information has an error, you use the error code values of either "shippingContactInvalid" or "billingContactInvalid" to indicate which one has the error. You use the contact field to indicate the exact field with the error. The corresponding field in the shipping or billing section of the payment sheet is highlighted.

Note that the remaining error codes, "addressUnserviceable" and "unknown", do not require contact fields.

Use contact field values in the contactField property of an ApplePayError when you return errors in the completion functions, as shown in the following table.

Contact field values are available in all versions of the API except as stated in the table.

Contact Field Value

Completion methods that support "shippingContactInvalid" error code

Completion methods that support "billingContactInvalid" error code

"phoneNumber"

Completepayment

"emailAddress"

Completepayment

"name"

Completepayment

Completepayment

"phoneticName" [Image] (available starting in API version 3)

Completepayment

Completepayment

"postalAddress"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"addressLines"

Completepayment

Completepayment

"locality"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"subLocality"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"postalCode"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"administrativeArea"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"subAdministrativeArea"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"country"

Completeshippingcontactselection [Image] Completepayment

Completepayment

"countryCode"

Completeshippingcontactselection [Image] Completepayment

Completepayment

Topics

Enumeration Cases

See Also

Status and errors