Apple Pay

Request and process Apple Pay payments in your app.

Topics

Apple Pay Setup

Setting Up Apple Pay Requirements

Complete the requirements needed to use Apple Pay in your apps.

Apple Pay Availability

Determine if the device supports Apple Pay and whether the user has added payment cards.

PKPaymentAuthorizationController

Presents a sheet that prompts the user to authorize a payment request.

PKPaymentAuthorizationViewController

Prompts the user to authorize a payment request.

Apple Pay Buttons

PKPaymentButton

Provides a button that is used either to trigger payments through Apple Pay or to prompt the user to set up a card.

Payment Requests

PKPaymentRequest

Encapsulates a request for payment, including information about payment processing capabilities, the payment amount, and shipping information.

Payment Sheet Interactions and Authorization

PKPaymentAuthorizationResult

Reports the status code and errors that you return when a payment is authorized.

PKPaymentAuthorizationController

Presents a sheet that prompts the user to authorize a payment request.

PKPaymentAuthorizationViewController

Prompts the user to authorize a payment request.

PKPayment

Represents the result of authorizing a payment request and contains payment information, encrypted in the payment token.

Payment Sheet Updates

Process the user's changes and update the payment sheet.

PKPaymentRequestPaymentMethodUpdate

Updates the payment request after the payment method changed.

PKPaymentRequestShippingContactUpdate

Updates the payment request after the shipping contact information changed.

PKPaymentRequestShippingMethodUpdate

Updates the payment request after the shipping method changed.

PKPaymentRequestUpdate

Base class for updating the payment request after the user makes changes on the payment sheet.

Entitlements

Merchant IDs Entitlement

A list of merchant IDs your app uses for Apple Pay support.

Key: com.apple.developer.in-app-payments
Pass Type IDs Entitlement

A list of identifiers that specify pass types that your app can access in Wallet.

Key: com.apple.developer.pass-type-identifiers

Errors

Provide granular error information for contact and address data.

PKPaymentErrorCode

An error code that you provide to indicate problems with address or contact information on an Apple Pay sheet.

PKPaymentErrorDomain

The error domain for specific errors associated with Apple Pay in-app or web payments.

PKPaymentErrorKey

Additional details about an error on the Apple Pay sheet.

Deprecated

PKAddressField

Billing or shipping address fields.

Deprecated