Apple Pay Drop-in integration

Add Apple Pay to an existing iOS Drop-in integration.

This page explains how to add Apple Pay to your existing iOS Drop-in integration.

If you are selling digital goods in your native iOS app, use Apple's in-app purchase instead of Apple Pay.

Requirements

Select which endpoint you are using:

Set up Apple Pay

Enable Apple Pay with your own 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 Drop-in 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.

Drop-in configuration

When you configure Drop-in, you need additional configuration for Apple Pay.

Optional configuration

Recurring payments

To enable recurring payments, you must include PKRecurringPaymentRequest 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.
1. Enable Apple Pay on your Apple Pay Developer account for your live merchant identifier.
2. Configure your firewall's allow-list:
  - Allow Apple IP Addresses for Domain Verification
  - Include out.adyen.com in your configuration to allow communication from our network.
We do not provide a list of IP addresses for allow-listing, because over time the list may change for various reasons, for example, due to ISP configuration changes.

If you are unable to configure your firewall with a domain allow-list, attempt to resolve our IP addresses by performing a DNS lookup on out.adyen.com, and then add those IP addresses to your allow-list. Beware that you still run the risk of a disruption if the IP addresses change.