Apple Pay on the Web
Interactive Demo

Requirements

This demo uses the Payment Request API, and to run this demo you need to use:

• iOS devices running iOS 11.3 or later
• Safari 11.1 with macOS 10.13 or later

Display an Apple Pay button

To display an Apple Pay button, use the following code to load the button script into your web page from the content delivery network:

<script crossorigin
        src="https://applepay.cdn-apple.com/jsapi/1.latest/apple-pay-sdk.js"
        ></script>

The JavaScript Apple Pay button provides a variety of Apple Pay button types that you can use on your website to initiate a transaction. You can specify the Apple Pay button style, type, and localization using attributes. Use CSS to set other properties, such as the size and corner radius. Using the official Apple Pay button element ensures your site displays the latest style, renders correctly across devices, and follows Apple guidelines. For design guidance, see Human Interface Guidelines > Apple Pay > Buttons and Marks.

Try it: Display settings

Use the following tools to try the different display settings on the button below:

<style>
apple-pay-button {
  --apple-pay-button-width: 150px;
  --apple-pay-button-height: 30px;
  --apple-pay-button-border-radius: 3px;
  --apple-pay-button-padding: 0px 0px;
  --apple-pay-button-box-sizing: border-box;
}
</style>
<apple-pay-button buttonstyle="black" type="plain" locale="en-US"></apple-pay-button>

Create a Payment Request

When your customer clicks or taps the Apple Pay button, you construct a PaymentRequest.

var request = null;
if (window.PaymentRequest)
    request = new PaymentRequest(methods, details, options);
else
    // Consider using Apple Pay JS instead.

The PaymentRequest constructor takes three arguments:

• The payment methods you support
• The details to show to your customer (like shipping options and total amount)
• The options you require

Payment methods

Payment methods represent the means by which you can accept payments from your customer using the Payment Request API. You specify the payment methods you accept as a sequence of PaymentMethodData dictionaries, each of which contains an identifier (supportedMethods) and associated information (data).

To accept payments using Apple Pay through the Payment Request API, include it as a payment method. Apple Pay’s URL-based payment method identifier is "https://apple.com/apple-pay", and its associated data is an ApplePayRequest dictionary.

Safari supports only the Apple Pay payment method. Other browsers may support additional methods. The system determines which payment methods to present based on the capabilities of the device and on user preferences when specifying more than one method.

Try it: Apple Pay method

You may configure the values in the PaymentMethodData structure below.

Select “Basic request” to see a payment sheet with only the required fields. Select “Detailed request” to include optional fields.

Click or tap the Apple Pay button below to see how the payment sheet displays information.

Payment details

Supply the payment details in the PaymentDetailsInit dictionary. It contains your transaction’s total amount, display items, shipping options, and payment method-specific modifiers.

Select a default shipping option by setting the selected attribute to true as this demo shows in Try it: Payment details for "Ground Shipping" when selecting “More details“. The total amount needs to be $0.00 or greater, and when using Apple Pay, all payment amounts in your request need to use the same ISO 4217 currency code. It’s your responsibility to ensure the correctness of your payment details; Safari doesn’t perform any currency calculations on your behalf.

Payment modifiers

Apple Pay can update your transaction’s display items and total when you include optional modifiers in your payment details. For example, you can adjust the price based on the type of payment card.

Modifiers provide some of the functionality present in the paymentmethodselected event. For more information, see ApplePayModifier.

You can set up recurring payments, such as subscriptions, that feature different payment intervals (such as annually or monthly) and billing cycles (such as regular or trial) by passing recurringPaymentRequest to the ApplePayModifier with the ApplePayLineItem that has a recurring paymentTiming.

You can set up deferred payments, where a user pays at a later date, by passing ApplePayLineItem that has a recurring paymentTiming and a valid date in the deferredPaymentDate property in the ApplePayModifier additionalLineItems.

You can set up automatic reload payments, such as store card top-ups, by passing automaticReloadPaymentRequest to the ApplePayModifier with the ApplePayLineItem that has an automaticReload paymentTiming, the amount to describe the reload amount, and the automaticReloadPaymentThresholdAmount to describe the threshold amount balance to reach before automatically applying the reload amount.

You can set up multitoken transactions to process and display payments with multiple merchants on one payment sheet, such as a booking site where a user pays for a hotel, a flight, and a car rental from different merchants in a single Apple Pay transaction. You can do this by passing ApplePayPaymentTokenContext in the multiTokenContexts property to the ApplePayModifier.

Try it: Payment details

Modify the values in the PaymentDetailsInit structure below and click or tap the Apple Pay button to view the payment sheet.

Payment options

Use PaymentOptions to specify the information to request from your customer. You can request your customer’s name, email address, or phone number, or request a certain type of shipping.

Try it: Payment Options

You may configure the values in the PaymentOptions structure below.

Select ”Request no additional information” to see a payment sheet with no customer data requests. Select ”Request shipping information” to see a payment sheet with only a shipping request. Select ”Request all information” to see a payment sheet with all customer data requests.

Click or tap the Apple Pay button to see how the payment sheet displays information.

Complete merchant validation

Before you are able to display the payment sheet to the customer, you need to generate a valid payment session by interacting with Apple Pay servers. For security reasons, your server needs to do this interaction, not your browser client code, unlike everything else in this demo. To start the merchant validation process, call the show method on the PaymentRequest you created above.

After calling the show method, the browser invokes your onmerchantvalidation handler, which needs to fetch a merchant session from your server.

Refer to the instructions in Requesting an Apple Pay Payment Session to implement your server endpoint responsible for fetching the merchant session object from Apple Pay servers. If the fetch is successful, Apple Pay servers return a merchant session object, which your server needs to then pass back as the response to the browser.

You need to complete your onmerchantvalidation handler by passing the promise, containing the merchant session response, to the complete method on the event. The browser then displays the payment sheet.

The following code shows an example of how to validate a merchant to generate a payment session:

request.onmerchantvalidation = event => {
    // Call your own server to request a new merchant session.
    const merchantSessionPromise = fetch("/authorizeMerchant")
        .then(res => res.json()) // Parse the response as JSON.
        .catch(err => {
            console.error("Error fetching merchant session", err);
        });

    event.complete(merchantSessionPromise);
};

Respond to payment sheet interactions

After merchant validation is complete, Apple Pay provides the information about your customer’s payment sheet selections so that you can calculate the final transaction cost. The final details of a transaction may depend on the user’s payment method, shipping address and method, or any coupons the user enters. To handle these adjustments, implement the optional handlers onpaymentmethodchange, onshippingoptionchange, and onshippingaddresschange. In the event handlers, you can determine the user’s selection using the PaymentRequest shippingOption and shippingAddress attributes.

When the browser calls one of these handlers, you need to call the event object’s updateWith callback function with a promise that resolves within 30 seconds to a PaymentDetailsUpdate; otherwise, the transaction times out.

Request a shipping address

If you set requestShipping to true in the PaymentOptions dictionary, Apple Pay provides redacted address information before the user authenticates the transaction. After the user authenticates, Apple Pay provides the full contact information in the PaymentResponse that the show method’s returned promise resolves.

The redacted payment information includes only the data necessary to complete required transaction tasks, such as calculating taxes or shipping costs, and may differ based on the user’s geographic region.

The following code shows an example of redacted payment information:

shippingAddress:
{
    "administrativeArea": "CA",
    "country": "United States",
    "countryCode": "US",
    "familyName": "",
    "givenName": "",
    "locality": "San Francisco",
    "phoneticFamilyName": "",
    "phoneticGivenName": "",
    "postalCode": "94114",
    "subAdministrativeArea": "",
    "subLocality": ""
}

Try it: Updating payment details

You may customize the PaymentDetailsUpdate below.

Select one of the Success options below (with or without updating display items and total) to see a successful response. Select Failure to see response with custom errors.

Click or tap the Apple Pay button to see how the payment sheet displays updates or address errors.

Authorize the payment

Finally, you receive a PaymentResponse through the show method’s returned promise to process the transaction. After the user authenticates the transaction using Face ID, Touch ID, or their device passcode, this promise resolves with the encrypted Apple Pay token, as well as any fields you request in the PaymentOptions. To finalize the transaction, you need to pass the encrypted payment token to your payment processor using their API.

After you receive the response from your payment processor, call the complete method on the response and pass in a status of success or fail.

You may also validate the user’s information, and invoke the complete method immediately, without calling the payment processor, if you detect a problem with the selected options (for example, if the user selects a shipping address in a location that you don’t service).

The following code shows an example of passing a status to the complete method:

const response = await request.show();
const status = "success";
await response.complete(status);
    

Try it: Complete the payment

You may customize the complete response below.

Select Success to default to success. Select Failure to see a fail response.

Click or tap the Apple Pay button to see how the payment sheet completes the payment.

Disbursements

Implement the Disbursement Request API to disburse funds to your customer. With the Disbursement Request API, you can allow your site visitors to transfer funds from your site to an account that is linked to a card in Wallet. The Disbursement Request API is only available as a subset of the Payment Request API.