Apple Pay Drop-in integration

1. Set up your server for secure communication with Apple Pay.
   • All pages that include Apple Pay must be served over HTTPS.
   • Your domain must have a valid SSL certificate.
2. Add Apple Pay in your test Customer Area.
   • You'll be asked for Shop websites: your website URLs, for example https://www.mystore.com. If you add more than one, separate them with a comma.
   • You cannot use http://localhost to test.

3. Make sure that you are using Drop-in version 3.18.0 or later.

1. Set up your server for secure communication with Apple Pay.
2. Enable Apple Pay using your own Apple Developer account and certificate.

This is the default with Drop-in 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 Drop-in if you're using your own Apple Pay certificate:

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();
            });
    }
};

Include the applePayConfiguration object when creating a configuration object:

const configuration = {
  // ...  other required configuration
  paymentMethodsConfiguration: {
    applepay: applePayConfiguration
  }
};

If you implemented an additional use case.

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 Drop-in if you're using Adyen's Apple Pay certificate:

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

Include the applePayConfiguration object when creating a configuration object:

const configuration = {
  // ...  other required configuration
  paymentMethodsConfiguration: {
    applepay: applePayConfiguration
  }
};

Use your own Apple Pay certificate

The following example shows how to configure Drop-in if you're using your own Apple Pay certificate and Drop-in v3.17.0 or earlier.

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]
};

Include the applePayConfiguration object when creating a configuration object:

const configuration = {
  // ...  other required configuration
  paymentMethodsConfiguration: {
    applepay: applePayConfiguration
  }
};

1. Download and unzip the domain association file.

2. Host the domain association file with the name apple-developer-merchantid-domain-association on each domain you want to use, including subdomains, under the following path:

   /.well-known/apple-developer-merchantid-domain-association

   The file must:

   • Have Content-Type: text/plain in the header.
   • Be externally accessible.
   • Not be password protected.
   • Not be behind a proxy or redirect.
   • Be hosted with the Unix line ending.

   See an example of a working domain association file.

3. Add the following IP addresses to your firewall's allow list:

   • Allow Apple IP Addresses for Domain Verification
   • Any IP originating from *.adyen.com

4. Add Apple Pay in your live Customer Area

   • You'll be asked for Shop websites: your website URLs, for example https://www.mystore.com. If you add more than one, separate them with a comma.