ApplePaySession(version, paymentRequest)

The entry point for Apple Pay on the web.


ApplePaySession(unsigned long version, ApplePayPaymentRequest paymentRequest)



The Apple Pay version number your website supports. See Apple Pay on the Web Version History for version information.


An ApplePayPaymentRequest object that contains the information to be displayed on the Apple Pay payment sheet.


Creating an ApplePaySession object throws a JavaScript exception if any of the following occur:

  • Any Apple Pay JS API is called from an insecure page.

  • You pass an invalid payment request. Payment requests are invalid if they contain missing, unknown, or invalid properties, or if the total is zero or less.

  • You attempt to create ApplePaySession outside of a gesture handler.

Check supportsVersion before using any Apple Pay JS API that depends on Safari to support a particular version number.

See Also