Overview

Required plan

This feature or setting is available to all customers on any Recurly subscription plan.

Use cases

E-commerce platforms looking to enhance user experience with a swift and secure payment method.
Subscription services aiming to streamline the payment process for their customers.

Prerequisites & supported gateways

To integrate Apple Pay on the Web, ensure you have:

An Apple Developer's Account and a verified domain.
Recurly.js v4 or Checkout.
Recurly currently supports Apple Pay transactions through Adyen, Stripe, Braintree, Vantiv, Worldpay, Chase Orbital, and Cybersource as gateways.
This payment method allows using Zero Dollar Authorizations.

Limitations

Not available on Recurly Hosted Payment Pages (HPP).

Description

Recurly supports Apple Pay on the Web, allowing a smooth and secure payment process on your web pages. Before initiating the integration, familiarize yourself with Apple's getting started guide .

Checkout flow

Once you have completed the prerequisites, contact Recurly Support to initiate the following actions:

Enable the Apple Pay Web Payments feature flag for your site.
- After enabling the feature flag, a new Apple Pay checkbox will appear in your Gateway Settings. Make sure this box is checked so you can upload keys and certificates under Configuration > Apple Pay in your Recurly site.
Generate Merchant ID and Payment Processing Keys
Recurly Support will provide the keys you need for Apple Pay integration.
Generate Certificate Signing Requests (CSRs)
These CSRs are required to create the Apple Pay Payment and Merchant Identity certificates. Each CSR is unique to your merchant account, so allow several business days for these files to be generated by Recurly Support. You must use the Recurly-provided CSRs to ensure the integration functions correctly.

Configuration in Apple and Recurly

After receiving the necessary keys and CSRs from Recurly Support, follow these steps to create certificates in the Apple Developer portal and configure them in Recurly:

Request an “Apple Pay Certificate” in the Apple Developer portal.
Select the correct Merchant ID on the following page.
Upload the CSR named payment.csr.
Repeat the above steps, but this time choose “Merchant Identity Certificate” and upload the merchant_id.csr file.

Tip:

The Merchant Identity Certificate authenticates your merchant sessions with Apple Pay servers.

The Apple Pay Certificate (Payment Processing Certificate) is used to process transactions through Apple Pay.

Upload certificates and finalize setup in Recurly

Open the Recurly console and select Configuration > Apple Pay to begin setup.
Enter your verified domain in the format www.DOMAIN.com.
- Important: Do not use the domain listed under the cert_UID field. This is a common mistake. Always use your actual store domain.
Input your store name, as it should appear to customers during checkout.
Provide a link where customers can update billing information, e.g., https://www.DOMAIN.com/login.
- If you use Hosted Pages Account Login, Recurly can determine this URL automatically.
Upload the keys and certificates in the corresponding fields:
- Payment Processing Key → Payment Processing Private Key
- Merchant ID Key → Merchant ID Private Key
- Merchant Identity Certificate → Merchant ID Certificate
- Apple Pay Certificate → Payment Processing Certificate

Once these steps are complete, you’ll be able to accept Apple Pay transactions via your Recurly site. If you have any questions or encounter issues, contact Recurly Support for assistance.

Braintree Setup

Setting up Recurly's Apple Pay integration with Braintree differs from other gateways and involves coordination between Recurly and Braintree.

1. Enable Apple Pay on Braintree

Adhere to the guidelines provided in the Braintree documentation.

Update the Recurly.js V4 checkout page to incorporate Apple Pay with Braintree client authorization as delineated in Recurly's developer documentation.

2. Enable Apple Pay on Recurly

Contact Recurly to activate the Feature Flag for Enable Apple Pay Web Payments.
Select the Enable Apple Pay option on the Gateway Configuration page for Braintree within Recurly.

Note: When using Apple Pay with Braintree, there is no need for additional configurations in Recurly under Configuration → Apple Pay.

FAQs

1. What is Apple Pay on the Web?

Apple Pay on the Web is a payment method that allows customers to make secure and fast payments on websites using Apple Pay. It is supported through Recurly.js v4 and can be integrated into your web pages for a streamlined checkout experience.

2. What are the prerequisites for integrating Apple Pay on the Web with Recurly?

Before integrating Apple Pay on the Web with Recurly, you need to:

Create an Apple Merchant ID and sign up for an Apple Developer's Account.
Verify the domain where your checkout page will reside.
Upgrade to Recurly.js v4.
Add a supported payment gateway to your Recurly site.

3. How do I enable Apple Pay on the Web for my website?

To enable Apple Pay on the Web, follow the detailed guide in the "Getting Started" section of the user guide. It involves setting up your Apple Developer's account, configuring settings in both the Apple and Recurly platforms, and working closely with Recurly Support to enable necessary features and obtain Certificate Signing Request (CSR) files.

4. What are Apple Pay Certificates and why are they necessary?

Apple Pay Certificates, including the Merchant Identity Certificate and Payment Processing Certificate, are essential for authenticating your merchant sessions with Apple Pay servers and processing transactions on your behalf. They ensure secure and smooth transactions through Apple Pay on your website.

5. How do I set up Apple Pay with Braintree?

Setting up Apple Pay with Braintree involves a different process compared to other gateways. You need to follow Braintree's Apple Pay documentation to enable it on Braintree, and then enable the feature flag for Apple Pay web payments on Recurly. There is no need for additional configurations under "Configuration → Apple Pay" in Recurly when using Apple Pay with Braintree.

7. Can I use Apple Pay on the Web with Recurly hosted payment pages?

No, Apple Pay on the Web is currently not supported on Recurly hosted payment pages. It is designed to be integrated into your web pages through Recurly.js v4. However, Checkout uses Recurly.js v4 and therefore you can use Apple Pay on the Checkout pages. See Checkout for more info.

8. How do I contact Recurly Support for assistance?

For assistance with setting up Apple Pay on the Web or any other inquiries, you can reach out to Recurly Support through their support page.

9. Where can I find detailed documentation for integration?

You can find detailed documentation and guidelines for integration in the Recurly.JS documentation .

10. What do I do when my CSRs are about to expire?

Reach out to Recurly Support to have them generate new CSRs for you. At this stage, we recommend you delete and add all files yourselves to control any downtime that may occur once the old files are removed. This way you can minimize any potential impact that may occur for the customers who use Apple Pay.