Apple Pay for API only

Accept Apple Pay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Set up Apple Pay

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

You can use Adyen's Apple Pay certificate if you have a web integration, which makes it quicker to set up Apple Pay. If you have a mobile integration, use your own Apple Developer account and certificate which requires extra configuration steps:

Build your payment form for Apple Pay

After you have finished enabling Apple Pay, you can show Apple Pay as an available payment method in countries/regions where Apple Pay is supported. You can download logos for Apple Pay which you can use on your payment form.

When the shopper selects Apple Pay, they are presented with a prompt to verify the payment using Touch ID or Face ID. If the shopper is using a Mac without Touch ID, they will be prompted to verify the payment using an iPhone or Apple Watch registered to the same iCloud account.

1. Make a /paymentMethods request, specifying:

   • countryCode: Countries/regions where Apple Pay is supported. For example, NL.
   • amount.currency: Any supported currency. For example, EUR.
   • channel: Set this to Web if the payment is being initiated from Safari, or iOS for in-app payments.

2. In the response, you receive:

   • type: applepay.
   • merchantId and merchantName: If you use Adyen's Apple Pay certificate, you need these details in the next step to complete the Apple Pay session validation.

{
  "paymentMethods": [
    ...
    {
        "brands": [
            "amex",
            "mc"
        ],
        "configuration": {
            "merchantId": "com.test.merchant",
            "merchantName": "Your Store"
        },
        "details": [
            {
                "key": "applepay.token",
                "type": "applePayToken"
            }
        ],
        "name": "Apple Pay",
        "type": "applepay"
    },
    ...
  ]
}

Complete the Apple Pay session validation

When the shopper selects to pay with Apple Pay, you get the onvalidatemerchant event handler. You then need to complete the Apple Pay session validation using the completeMerchantValidation method.

You can do this by using Adyen's Apple Pay certificate, or you can use your own:

If the Apple Pay session is successfully validated, Apple Pay prompts the shopper to authorize the payment using Touch ID or Face ID.

Make a payment

1. After the shopper authorizes the payment, get the token from the Apple Pay framework and decrypt it in one of two ways:

   • Let Adyen handle the decryption
   • Handle the decryption yourself. This is only allowed if you are PCI-compliant.

2. Stringify and Base64-encode the entire paymentData object.

3. From your server, make a /payments request providing:

   • paymentMethod.type: applepay
   • applePayToken: The stringified and base64 encoded paymentData you retrieved from the Apple framework. 

   The response contains the result of the payment.

   {
     "pspReference": "881539337151149C",
     "resultCode": "Authorised"
   }

Present the payment result

Use the resultCode that you received in response to your /payments call to present the payment result to your shopper.

The resultCode values you can receive for Apple Pay are:

Recurring payments

To make recurring Apple Pay payments, first 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.
• Implementing Apple Pay for your website or app.

Enable Apple Pay either using Adyen's Apple Pay certificate, which is quicker, or you can also use your own Apple Developer account and certificate which requires extra configuration steps:

See also