Integrate Apple Pay with JS SDK for direct merchants

Apple Pay integration

Apple Pay is a mobile payment and digital wallet service provided by Apple Inc.

Buyers can use Apple Pay to make payments on the web using the Safari web browser or an iOS device.

Sellers can use Apple Pay to sell:

Visit this site for more information about Apple Pay.

Supported countries and currencies

Apple Pay supports payments in 34 countries and 22 currencies:

How it works

The Apple Pay button shows up on your website when a customer uses the Safari web browser on an eligible device.

When your buyer selects the Apple Pay button:

The payment sheet helps streamline the checkout process by showing the customer the information needed to make the payment.

Payment sheets can show the user's name, address, shipping information, and email address. You can customize this payment sheet to include the user details and payment information you need for your Apple Pay integration.

Visit this site for more details about Apple Pay's compatibility.

Integration video

Watch our video tutorial for this integration:

Know before you code

Get up and running in GitHub Codespaces

GitHub Codespaces are cloud-based development environments where you can code and test your PayPal integrations. Learn more

Open in Codespaces

1. Set up your sandbox account to accept Apple Pay

Before you can accept Apple Pay on your website, verify that your sandbox business account supports Apple Pay. Use the PayPal Developer Dashboard to set up your sandbox account to accept Apple Pay.

If you created a sandbox business account through sandbox.paypal.com, and the Apple Pay status for the account shows as disabled, complete the sandbox onboarding steps to enable Apple Pay.

2. Getting started in your testing environment

Before you develop your Apple Pay on the Web integration, you need to complete Get started to set up your PayPal account, client ID, and sandbox emails for testing.

Download and host sandbox domain association file

Register your sandbox domains

Create Apple Pay sandbox account

Create an Apple Pay sandbox account on the Apple Developer website to get a test wallet and test cards to test your Apple Pay integration.

If you already have an Apple sandbox account, you can use that account and move on to the next step.

3. Integrate Apple Pay checkout

Follow this integration process to add Apple Pay as a checkout option, customize the payment experience, and process payments.

Call the Orders API

To accept Apple Pay directly on your website, create API endpoints on your server that communicate with the PayPal Orders V2 API. These endpoints can create an order, authorize payment, and capture payment for an order.

Server-side example (Node.js)

The following example uses the PayPal Orders V2 API to add routes to an Express server for creating orders and capturing payments.

import * as PayPal from "./paypal-api.js";

/* Create Order route Handler */
app.post("/api/orders", async (req, res) => {
  const order = await PayPal.createOrder();
  res.json(order);
});

/* Capture Order route Handler */
app.post("/api/orders/:orderID/capture", async (req, res) => {
  const { orderID } = req.params;
  const captureData = await PayPal.capturePayment(orderID);
  res.json(captureData);
});

4. Set up your Apple Pay button

You need to Integrate with the Apple Pay JavaScript SDK and PayPal JavaScript SDK to add Apple Pay to your site.

Integrate PayPal JavaScript SDK

Use this script to integrate with the PayPal JavaScript SDK:

<script src="https://www.paypal.com/sdk/js?client-id=YOUR_CLIENT_ID&currency=USD&buyer-country=US&merchant-id=SUB_MERCHANT_ID&components=applepay"></script>

Include applepay in the components list.

Integrate Apple JavaScript SDK

Use this script to integrate with the Apple JavaScript SDK:

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

PayPal's Apple Pay component interacts with your JavaScript code in 4 areas:

Before you show the Apple Pay button, make sure that you can create an Apple Pay instance and that the device can make an Apple Pay payment.

Use ApplePaySession.canMakePayments to check if the device can make Apple Pay payments.

Check for device and merchant eligibility before setting up the Apple Pay button.

To check eligibility, use the PayPal JavaScript SDK API paypal.Applepay().config().

<div id="applepay-container"></div>

if (!window.ApplePaySession) {
  console.error("This device does not support Apple Pay");
}
if (!ApplePaySession.canMakePayments()) {
  console.error("This device is not capable of making Apple Pay payments");
}
const applepay = paypal.Applepay();
applepay
  .config()
  .then((applepayConfig) => {
    if (applepayConfig.isEligible) {
      document.getElementById("applepay-container").innerHTML =
        '<apple-pay-button id="btn-appl" buttonstyle="black" type="buy" locale="en">';
    }
  })
  .catch((applepayConfigError) => {
    console.error("Error while fetching Apple Pay configuration.");
  });

5. Create Apple Pay session

The ApplePaySession object manages the Apple Pay payment process on the web. Create a new ApplePaySession each time a buyer explicitly requests a payment, such as inside anonclick event. If you don't create anApplePaySession each time, you get a "Must create a newApplePaySession from a user gesture handler" JavaScript exception. For more information about this error, visit Apple's Creating an Apple Pay Session page.

For each ApplePaySession, create anApplePayPaymentRequest object, which includes information about payment processing capabilities, the payment amount, and shipping information.

The response object of the PayPal JavaScript SDK API paypal.Applepay().config() provides the following parameters in the ApplePayPaymentRequest object:

const paymentRequest = {
  countryCode: applepayConfig.countryCode,
  merchantCapabilities: applepayConfig.merchantCapabilities,
  supportedNetworks: applepayConfig.supportedNetworks,
  currencyCode: "USD",
  requiredShippingContactFields: ["name", "phone", "email", "postalAddress"],
  requiredBillingContactFields: ["postalAddress"],
  total: {
    label: "Demo",
    type: "final",
    amount: "100.00",
  },
};
const session = new ApplePaySession(4, paymentRequest);

Include the new ApplePaySession inside a gesture handler, such as an onclick event or an addEventListener click handler.

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

onvalidatemerchant callback

Use paypal.Applepay().validateMerchant() in the onvalidatemerchant callback to create a validated Apple Pay session object:

session.onvalidatemerchant = (event) => {
  applepay
    .validateMerchant({
      validationUrl: event.validationURL,
      displayName: "My Store",
    })
    .then((validateResult) => {
      session.completeMerchantValidation(validateResult.merchantSession);
    })
    .catch((validateError) => {
      console.error(validateError);
      session.abort();
    });
};

onpaymentauthorized callback

Safari calls the onpaymentauthorized callback with an event object. The event object passes a token which you need to send to PayPal to confirm the order.

Capture the order using the PayPal Orders V2 API. Use paypal.Applepay().confirmOrder() to send the orderID, the Apple Pay token, billing contact details, and confirm the order.

session.onpaymentauthorized = (event) => {
  console.log("Your billing address is:", event.payment.billingContact);
  console.log("Your shipping address is:", event.payment.shippingContact);
  fetch("/api/orders", {
    method: "post",
    body: {},
  })
    .then((res) => res.json())
    .then((createOrderData) => {
      var orderId = createOrderData.id;
      applepay
        .confirmOrder({
          orderId: orderId,
          token: event.payment.token,
          billingContact: event.payment.billingContact,
        })
        .then((confirmResult) => {
          session.completePayment(ApplePaySession.STATUS_SUCCESS);
          fetch(`/api/orders/${orderId}/capture`, {
            method: "post",
          })
            .then((res) => res.json())
            .then((captureResult) => {
              console.log(captureResult);
            })
            .catch((captureError) => console.error(captureError));
        })
        .catch((confirmError) => {
          if (confirmError) {
            console.error("Error confirming order with applepay token");
            console.error(confirmError);
            session.completePayment(ApplePaySession.STATUS_FAILURE);
          }
        });
    });
};

6. Show the payment sheet

After you have created the Apple Pay session and added the callbacks, call the session.begin method to show the payment sheet. You can only call the begin method when a buyer explicitly requests a payment, such as inside an onclick event. The begin method throws a JavaScript exception if the buyer does not explicitly request the action:

session.begin();

After the buyer starts a payment in the browser, they use their Apple device to authorize the payment.

Customize payment

Customize the payment experience using the Apple Pay JavaScript SDK.

Per Apple's development guidelines, your Apple Pay integration needs to follow these rules:

The commonly used customizations for Apple Pay are:

7. Test your integration

Test your Apple Pay integration in the PayPal sandbox and production environments to ensure that your app works correctly.

Use your personal sandbox login information during checkout to complete a payment using Apple Pay. Then, log into the sandbox site sandbox.paypal.com to see that the money has moved into your account.

8. Go live

Make Apple Pay available to buyers using your website or app.

Live environment

If you're a new merchant, sign up for a PayPal business account.

Use your personal production login information during checkout to complete an Apple Pay transaction. Then log into paypal.com to see the money move out of your account.

Getting started in your live environment

Verify any domain names in your live environment that will show an Apple Pay button. Apple Pay transactions only work on a domain and site registered to you.

Prerequisites

Enable Apple Pay for your live account:

Create an app:

Download and host live domain association file

Host a domain association file for each high-level domain and subdomain that show the Apple Pay button.

Register your live domain on PayPal

Add all high-level domains that show the Apple Pay button.

After your domain is registered:

Testing in your live environment

When testing a purchase in production, consider:

How to test Apple Pay payments in a live environment:

Troubleshoot your integration

Make sure that there are no browser console warnings or errors. The JavaScript SDK configuration attributes have distinct validation checks for input formatting and values.

If the validation fails, the web browser's developer console shows warning messages that say which property is incorrect and what you need to do to address the issue. The library generally attempts to revert to the safe default values if missing or incorrect inputs exist.

Next steps & customizations

Get started testing, add security to your checkout experience or create customizations for your audience.