Apple Pay Component

This page explains how to add Apple Pay to your existing Web Components integration.

Requirements

Select which endpoint you are using:

Set up Apple Pay

Enable Apple Pay with your own or Adyen's Apple Pay certificate.

API reference

You do not need to send additional fields for Apple Pay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

• /sessions: This is the default with Components v5.0.0 or later.
• /payments: If you implemented an additional use case.

If you run into an error, refer to Handle Apple Pay errors.

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

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

Step 2: Create an instance of the Component

Select which endpoint you are using:

Step 3: Mount the Component

Mount the Component only after checking that Apple Pay is available to the shopper:

applePayComponent
   .isAvailable()
   .then(() => {
       applePayComponent.mount("#applepay-container");
   })
   .catch(e => {
       //Apple Pay is not available
   });

Optional configuration

You can do the following:

• Configure the appearance of the Apple Pay button.
• Include additional data such as transaction information, fields for billing and shipping contact information.
• Add logic for specific events on your payment form.

Button configuration

Payment request data

Events

The following event handlers are supported for Apple Pay. Select the event handler names to see the related Apple Pay documentation.

v6.0.0 or later

Create an instance of the Component, passing:

• Your instance of AdyenCheckout.
• The payment method-specific configuration.

const applePay = new ApplePay(checkout, applePayConfiguration).mount('#applepay-container');

const applePayComponent = checkout.create('applepay', applePayConfiguration).mount('#applepay-container');

Optional Apple Pay Wallet Order Tracking

Supported in v6.0.0 or later.

You can use Apple Pay Wallet Order Tracking to give your shopper order tracking through Apple Pay. For more information, refer to the following resources from Apple:

• Apple Pay Wallet Order Tracking Demo
• Apple Pay Tech Talk about implementing Apple Pay with order management
• Example Order Packages

1. Implement onOrderTracking:

2. When onOrderTracking is called depends on which server-side flow your integration uses.

3. From your server, get the order details and pass it as orderDetails to your client side.
   If an error occurs, the Apple Pay payment overlay is closed, and the payment is successfully completed without creating an order in the shopper's Apple Wallet app.

Recurring payments

To enable recurring payments, you must include recurringPaymentRequest when configuring Apple Pay.

To make recurring Apple Pay payments, you have to create a shopper token and then make subsequent recurring transactions with the token.

Test and go live

Use Apple's test card numbers to test your integration.

For a full list of test cards and instructions how to add these to your test device, see Sandbox testing on Apple's Developer website.

Check the status of an Apple Pay test payment in your Customer Area > Transactions >  Payments.

Going live

To process live Apple Pay payments, your API credential needs to have the API Clientside Encryption Payments role. You can check this in your live Customer Area or ask your Admin user to verify.

Make sure that you follow Apple's guidelines on:

• Designing your Apple Pay integration.

See also