Apple Pay JS API

Apple's JavaScript API for implementing Apple Pay on the web.

Topics

Apple Pay Availability

Checking for Apple Pay Availability

Detect if the Apple Pay JS API is available and if payments are possible.

canMakePayments

Indicates whether the device supports Apple Pay.

canMakePaymentsWithActiveCard

Indicates whether the device supports Apple Pay and whether the user has an active card in Wallet.

Apple Pay Payment Request

ApplePayPaymentRequest

A request for payment, which includes information about payment processing capabilities, the payment amount, and shipping information.

Apple Pay Session

Creating an Apple Pay Session

Provide a payment request and create the session.

Providing Merchant Validation

Validate your merchant identity and receive a session object for each payment request.

Requesting an Apple Pay Payment Session

Request a valid session from the Apple Pay server.

ApplePaySession

A session object for managing the payment process on the web.

Status and Errors

ApplePayError

A customizable error type that you create to indicate problems with the address or contact information on an Apple Pay sheet.

ApplePayErrorCode

The error code that indicates whether an error on the payment sheet is for shipping or billing information, or for another kind of error.

ApplePayErrorContactField

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

Apple Pay Status Codes

Codes used to report the status of an Apple Pay session after a callback.

See Also

Apple Pay JavaScript APIs

Choosing an API for Implementing Apple Pay on Your Website

Compare Apple Pay JS and Payment Request API to choose the right implementation for your website.

Apple Pay on the Web Version History

Learn about features in each Apple Pay version.

Payment Request API

A cross-browser API, under development by the W3C, for implementing Apple Pay on the web.