Apple Pay Component

On this page, you can find additional configuration for adding Apple Pay to your Components integration.

Before you begin

This page assumes you've already:

• Built a Components integration.
• Added Apple Pay in your Customer Area.

Set up Apple Pay

You can either use Adyen's Apple Pay certificate which makes it quicker to set up Apple Pay, or you can use your own Apple Developer account and certificate which requires extra configuration steps:

API reference

You don't 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 advanced use case, or integrated Components before v5.0.0.

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're integrating:

/sessions /payments

/sessions /payments

This is the default with Components v5.0.0 or later. If you are using /sessions together with Adyen's Apple Pay certificate, you don't need to add any additional configuration for Apple Pay. If using your own Apple Pay certificate, you need to include:

• onValidateMerchant: Required for displaying the Apple Pay payment sheet. For more information, see Apple Pay documentation.

The following example shows how to configure the Apple Pay Component if you're using your own Apple Pay certificate:

Apple Pay configuration

const applePayConfiguration = {
    //onValidateMerchant is required if you're using your own Apple Pay certificate
    onValidateMerchant: (resolve, reject, validationURL) => {
        // Your server uses the validation URL to request a session from the Apple Pay server.
        // Call resolve(MERCHANTSESSION) or reject() to complete merchant validation.
        validateMerchant(validationURL)
            .then(response => {
            // Complete merchant validation with resolve(MERCHANTSESSION) after receiving an opaque merchant session object, MerchantSession
            resolve(response);
            })
            .catch(error => {
            // Complete merchant validation with reject() if any error occurs
            reject();
            });
    }
};

https://docs.adyen.com/payment-methods/apple-pay/web-component#apple-pay-configuration

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component. Pass the configuration object if you created one:

const applePayComponent = checkout.create('applepay', applePayConfiguration);

If you implemented an advanced use case, or integrated Components before v5.0.0.

Parameter name	Required	Description
amount.value		The value of the payment, in minor units.
amount.currency		The currency code of the payment.
countryCode		The two-letter country code of your merchant account.
onValidateMerchant	Required if you're using your own Apple Pay certificate.	Required for displaying the Apple Pay payment sheet. For more information, see Apple Pay documentation.
configuration.merchantName	Required for v3.17.0 or earlier	Specifies the name that will be displayed on the form. In v3.17.1 and later, the Component takes the value from the paymentMethodsResponse in the AdyenCheckout instance configuration.
configuration.merchantIdentifier	Required for v3.17.0 or earlier, or if you want to offer Pay by Link	Specifies your Apple merchantId. In v3.17.1 and later, the Component takes the value from the paymentMethodsResponse in the AdyenCheckout instance configuration.
supportedNetworks	Required for v3.19.0 or earlier	Specifies the card networks you support. Use values from Apple Pay documentation. For v3.20.0 or later, the supported networks are configured automatically based on your Adyen Merchant account settings, but you can override them here.

Use Adyen's Apple Pay certificate

The following example shows how to configure the Apple Pay Component if you're Adyen's Apple Pay certificate:

Apple Pay configuration

const applePayConfiguration = {
    amount: {
        value: 1000,
        currency: "EUR"
    },
    countryCode: "DE"
};

https://docs.adyen.com/payment-methods/apple-pay/web-component#apple-pay-configuration

Use the create method of your AdyenCheckout instance, in this case checkout, to create an instance of the Component. Pass the configuration object that you created above:

const applePayComponent = checkout.create('applepay', applePayConfiguration);

Use your own Apple Pay certificate

The following example shows how to configure the Apple Pay Component if you're using your own Apple Pay certificate and Components v3.17.0 or earlier.

Apple Pay configuration

const applePayConfiguration = {
    amount: {
        value: 1000,
        currency: "EUR"
    },
    //onValidateMerchant is required if you're using your own Apple Pay certificate
    onValidateMerchant: (resolve, reject, validationURL) => {
        // Your server uses the validation URL to request a session from the Apple Pay server.
        // Call resolve(MERCHANTSESSION) or reject() to complete merchant validation.
        validateMerchant(validationURL)
            .then(response => {
            // Complete merchant validation with resolve(MERCHANTSESSION) after receiving an opaque merchant session object, MerchantSession
            resolve(response);
            })
            .catch(error => {
            // Complete merchant validation with reject() if any error occurs
            reject();
            });
    },
    configuration: {
        // Name to be displayed on the form.
        merchantName: "Adyen Test merchant",
        // Your Apple merchant identifier as described in https://developer.apple.com/documentation/apple_pay_on_the_web/applepayrequest/2951611-merchantidentifier
        merchantIdentifier: "adyen.test.merchant"
    },
    // Required for v3.19.0 or earlier. The networks you support. Use the values from https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentrequest/1916122-supportednetworks
    supportedNetworks: [amex, discover, visa]
};

https://docs.adyen.com/payment-methods/apple-pay/web-component#apple-pay-configuration

Use the create method of your AdyenCheckout instance, in this case checkout, to create an instance of the Component. Pass the configuration object that you created above:

const applePayComponent = checkout.create('applepay', applePayConfiguration);

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.

Use the create method of your AdyenCheckout instance, in this case checkout, to create an instance of the Component. Add the configuration object if you created one.

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

Recurring payments

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

Refer to Tokenization for more information and detailed instructions.

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 you follow Apple's guidelines on:

• Designing your Apple Pay integration.

See also