Apple Pay Component

Add Apple Pay to an existing iOS Components integration.

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

Requirements

Select which endpoint you are using:

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

Optional configuration

Recurring payments

You cannot use a token stored with Adyen to make a one-click payment with Apple Pay. You can use the token for subscription and unscheduled card-on-file payments.

Apple Pay already gives returning shoppers a one-click experience, because the payment details are stored in the wallet. The shopper confirms each payment on their device, and Apple Pay generates a cryptogram for that payment. If you make a payment request with a token stored with Adyen, the request does not include a cryptogram. Without a cryptogram, the card scheme usually refuses the payment. Some issuers and card schemes authorize these payments, but we do not recommend that you rely on this.

When a returning shopper makes a payment with Apple Pay, do not use a stored token for the payment. You can still create a token and use it for the subscription and unscheduled card-on-file payments that you initiate.

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

To make other types of recurring Apple Pay payments, you have to create a 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 > Payments > Payment list.

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.

Set up Apple Pay on your Apple Pay Developer account for your live merchant identifier.