---
title: ApplePaySession
framework: applepayontheweb
role: symbol
role_heading: Class
path: applepayontheweb/applepaysession
---

# ApplePaySession

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

## Declaration

```data
interface ApplePaySession
```

## Mentioned in

Creating an Apple Pay Session

## Overview

Overview ApplePaySession is the entry point for Apple Pay on the web.  All the steps of the payment process for a single transaction occur in a session. ApplePaySession belongs to the Apple Pay JS API.

## Topics

### Determining support for API and payments

- [supportsVersion](applepayontheweb/applepaysession/supportsversion.md)
- [applePayCapabilities](applepayontheweb/applepaysession/applepaycapabilities.md)
- [canMakePayments](applepayontheweb/applepaysession/canmakepayments.md)
- [canMakePaymentsWithActiveCard](applepayontheweb/applepaysession/canmakepaymentswithactivecard.md)

### Creating an Apple Pay session

- [ApplePaySession](applepayontheweb/applepaysession/applepaysession.md)

### Getting merchant validation

- [begin](applepayontheweb/applepaysession/begin.md)
- [onvalidatemerchant](applepayontheweb/applepaysession/onvalidatemerchant.md)
- [completeMerchantValidation](applepayontheweb/applepaysession/completemerchantvalidation.md)
- [ApplePayValidateMerchantEvent](applepayontheweb/applepayvalidatemerchantevent.md)

### Handling payment method updates

- [onpaymentmethodselected](applepayontheweb/applepaysession/onpaymentmethodselected.md)
- [completePaymentMethodSelection](applepayontheweb/applepaysession/completepaymentmethodselection.md)
- [ApplePayPaymentMethodUpdate](applepayontheweb/applepaypaymentmethodupdate.md)
- [ApplePayPaymentMethodSelectedEvent](applepayontheweb/applepaypaymentmethodselectedevent.md)
- [ApplePayPaymentMethod](applepayontheweb/applepaypaymentmethod.md)

### Handling coupons

- [oncouponcodechanged](applepayontheweb/applepaysession/oncouponcodechanged.md)
- [completeCouponCodeChange](applepayontheweb/applepaysession/completecouponcodechange.md)
- [ApplePayCouponCodeChangedEvent](applepayontheweb/applepaycouponcodechangedevent.md)
- [ApplePayCouponCodeUpdate](applepayontheweb/applepaycouponcodeupdate.md)

### Handling shipping contact updates

- [onshippingcontactselected](applepayontheweb/applepaysession/onshippingcontactselected.md)
- [completeShippingContactSelection](applepayontheweb/applepaysession/completeshippingcontactselection.md)
- [ApplePayShippingContactSelectedEvent](applepayontheweb/applepayshippingcontactselectedevent.md)
- [ApplePayShippingContactUpdate](applepayontheweb/applepayshippingcontactupdate.md)

### Handling shipping method updates

- [onshippingmethodselected](applepayontheweb/applepaysession/onshippingmethodselected.md)
- [completeShippingMethodSelection](applepayontheweb/applepaysession/completeshippingmethodselection.md)
- [ApplePayShippingMethodSelectedEvent](applepayontheweb/applepayshippingmethodselectedevent.md)
- [ApplePayShippingMethodUpdate](applepayontheweb/applepayshippingmethodupdate.md)

### Handling payment authorization

- [onpaymentauthorized](applepayontheweb/applepaysession/onpaymentauthorized.md)
- [completePayment](applepayontheweb/applepaysession/completepayment.md)
- [ApplePayPaymentAuthorizedEvent](applepayontheweb/applepaypaymentauthorizedevent.md)
- [ApplePayPayment](applepayontheweb/applepaypayment.md)
- [ApplePayPaymentAuthorizationResult](applepayontheweb/applepaypaymentauthorizationresult.md)

### Ending the session

- [oncancel](applepayontheweb/applepaysession/oncancel.md)
- [abort](applepayontheweb/applepaysession/abort.md)

### Displaying an Apple Pay setup button

- [openPaymentSetup](applepayontheweb/applepaysession/openpaymentsetup.md)

### Status code constants

- [STATUS_FAILURE](applepayontheweb/applepaysession/status_failure.md)
- [STATUS_INVALID_BILLING_POSTAL_ADDRESS](applepayontheweb/applepaysession/status_invalid_billing_postal_address.md)
- [STATUS_INVALID_SHIPPING_CONTACT](applepayontheweb/applepaysession/status_invalid_shipping_contact.md)
- [STATUS_INVALID_SHIPPING_POSTAL_ADDRESS](applepayontheweb/applepaysession/status_invalid_shipping_postal_address.md)
- [STATUS_PIN_INCORRECT](applepayontheweb/applepaysession/status_pin_incorrect.md)
- [STATUS_PIN_LOCKOUT](applepayontheweb/applepaysession/status_pin_lockout.md)
- [STATUS_PIN_REQUIRED](applepayontheweb/applepaysession/status_pin_required.md)
- [STATUS_SUCCESS](applepayontheweb/applepaysession/status_success.md)

## See Also

### Apple Pay session

- [Creating an Apple Pay Session](applepayontheweb/creating-an-apple-pay-session.md)
- [Providing Merchant Validation](applepayontheweb/providing-merchant-validation.md)
- [Requesting an Apple Pay payment session](applepayontheweb/requesting-an-apple-pay-payment-session.md)