ApplePaySession

Declaration

interface ApplePaySession

Mentioned in

• Creating an Apple Pay Session

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
• applePayCapabilities
• canMakePayments
• canMakePaymentsWithActiveCard

Creating an Apple Pay session

• ApplePaySession

Getting merchant validation

• begin
• onvalidatemerchant
• completeMerchantValidation
• ApplePayValidateMerchantEvent

Handling payment method updates

• onpaymentmethodselected
• completePaymentMethodSelection
• ApplePayPaymentMethodUpdate
• ApplePayPaymentMethodSelectedEvent
• ApplePayPaymentMethod

Handling coupons

• oncouponcodechanged
• completeCouponCodeChange
• ApplePayCouponCodeChangedEvent
• ApplePayCouponCodeUpdate

Handling shipping contact updates

• onshippingcontactselected
• completeShippingContactSelection
• ApplePayShippingContactSelectedEvent
• ApplePayShippingContactUpdate

Handling shipping method updates

• onshippingmethodselected
• completeShippingMethodSelection
• ApplePayShippingMethodSelectedEvent
• ApplePayShippingMethodUpdate

Handling payment authorization

• onpaymentauthorized
• completePayment
• ApplePayPaymentAuthorizedEvent
• ApplePayPayment
• ApplePayPaymentAuthorizationResult

Ending the session

• oncancel
• abort

Displaying an Apple Pay setup button

• openPaymentSetup

Status code constants

• STATUS_FAILURE
• STATUS_INVALID_BILLING_POSTAL_ADDRESS
• STATUS_INVALID_SHIPPING_CONTACT
• STATUS_INVALID_SHIPPING_POSTAL_ADDRESS
• STATUS_PIN_INCORRECT
• STATUS_PIN_LOCKOUT
• STATUS_PIN_REQUIRED
• STATUS_SUCCESS

See Also

Apple Pay session

• Creating an Apple Pay Session
• Providing Merchant Validation
• Requesting an Apple Pay payment session