WooPayments provides your store with Apple Pay, which makes it easier for customers to checkout using Touch ID or Face ID on Apple devices.
This document describes how to set up, test, and troubleshoot the Apple Pay feature in WooPayments.
To enable Apple Pay:
- Go to Payments > Settings.
- In the Express Checkouts section, check the box for Apple Pay / Google Pay.
- At the bottom of the page, click Save Changes.
These steps will:
- Create a domain registration file on your site that Apple will use to verify your site can offer Apple Pay.
- Communicate to our payment partners and Apple that your site is ready to accept payments via Apple Pay.
NOTE: There is no way to enable only Apple Pay without Google Pay. The two must be enabled together.
When Apple Pay is enabled, the Apple Pay button can appear in three places:
- On the Checkout page.
- On the Cart page.
- On individual product pages.
You can customize which of these locations show the Apple Pay button by going to Payments > Settings and then clicking the Customize link for Apple Pay / Google Pay in the Express Checkouts section.
Once there, you can change:
- Where the Apple Pay button shows up.
- The text of the Apple Pay button itself.
- The size and color scheme of the Apple Pay button.
By checking out with Apple Pay, customers don’t need to go through the regular checkout process and spend time filling in all of their information. Everything is handled using the Apple Pay interface, where customers can select their billing and shipping details, as well as which Apple Wallet card to use.
Once the transaction is authorized via Touch ID or Face ID, WooPayments then processes the transaction and redirects the customer to the “Order Received” / “Thank you” page.
You can test Apple Pay by making purchases in test mode using a real Apple ID with a real Apple Wallet card.
To perform a test payment via Apple Pay:
- Enable test mode by following the guide linked above.
- Follow the guidance in the Purchasing via Apple Pay section.
With test mode enabled, a purchase made using Apple Pay will use the real card details in your Apple Wallet without incurring any actual charges.
To set up Apple Pay on your device, you will need a supported card from a participating card issuer. See the full list of requirements for Apple Pay users for more information.
Apple Pay is very similar to card payments. As a result, it is compatible with many of the same features as credit or debit card payments — but not all of them. This section will dig into how Apple Pay handles many of these features.
No, there is no way to completely disable card payments during checkout while still using WooPayments for accepting Apple Pay.
Yes. If you have checked the “Issue an authorization on checkout, and capture later” option in Payments > Settings, you can manually capture authorized charges done with Apple Pay, just like other credit card transactions.
Yes. WooPayments allows you to issue refunds for Apple Pay transactions just like normal transactions. This section of our Managing Money guide shows how to refund a payment.
Yes. Customers can pay for goods and services via Apple Pay Later so long as the requirements set forth by Apple are met.
There are no additional transaction fees associated with purchases made via Apple Pay Later.
No. Apple Pay is not currently compatible with sandbox mode.
The Apple Pay integration in WooPayments is compatible with all of these product types:
- Simple products
- Variable products
- Simple subscriptions1 created via Woo Subscriptions
- Variable subscriptions1 created via Woo Subscriptions
- Bookable products2 created via WooCommerce Bookings
- Bundled products2 created via Product Bundles
- Composite products2 created via Composite Products
1 Subscription product purchases require a customer to have or create an account. Guest users can only purchase subscription products via Apple Pay if account username and password generation settings are enabled at WooCommerce > Settings > Accounts & Privacy.
2 For these types of products, the Apple Pay button cannot be shown on the product page itself. It will appear on the cart and checkout pages, if those are enabled.
Before troubleshooting Apple Pay, ensure you have Log Error Messages enabled under Payments > Settings > Advanced settings. This lets you see any error messages from WooPayments under WooCommerce > Status > Logs, which could potentially be useful if you need to contact our support staff.
To ensure there isn’t a problem with your browser and device combination, try using the Apple Pay button on another website. You can try this demo, for example.
- If Apple Pay does not appear on another site, there is likely not an issue with WooPayments itself.
- If Apple Pay does appear on that demo, but not on your WooPayments store, this can happen for several reasons. To try to remedy the issue, please make sure:
- The Apple Pay / Google Pay setting is enabled under Payments > Settings.
- Your site is not in sandbox mode.
- Your site is served over HTTPS.
- You’re testing with an eligible device and that Apple Pay is enabled.
- One of the following combinations of settings are configured in WooCommerce > Settings > Accounts & Privacy:
- Allow customers to place orders without an account is enabled.
- Both Allow customers to create an account during checkout and When creating an account, send the new user a link to set their password are enabled.
NOTE: There’s also an ongoing bug where Apple Pay may not appear in the Safari browser unless you uncheck the “Allow websites to check for Apple Pay and Apple Card” setting under the Privacy tab of the Safari settings.
If you’ve ruled out all of those potential issues, that may mean that WooPayments was unable to verify your domain with Apple. See the section below for some background and potential fixes.
What is domain registration? Is my domain registered?
In order for your store to accept Apple Pay transactions, your domain must be registered with and verified by Apple. WooPayments handles this for you automatically when you enable Apple Pay; it does this, in part, by hosting a
apple-developer-merchantid-domain-association file under your domain root.
This domain registration file should be accessible via your web browser at the following URL:
Please check if this file is available from your own site by replacing
example.com with your own domain.
The domain registration file is not accessible
apple-developer-merchantid-domain-association file is not accessible from your web browser, then WooPayments may be running into an issue creating it.
To recreate the file and go through the domain verification process again, you can:
- Navigate to Settings > Permalinks and make sure you have your permalinks set to anything other than Plain.
- If they already are set to anything other than Plain, re-save your permalinks.
- Trigger domain registration again by:
- Navigating to Payments > Settings.
- Unchecking the Apple Pay / Google Pay box in the Express Checkouts section.
- Scrolling to the bottom of the page.
- Selecting Save Changes.
- Checking the Apple Pay / Google Pay box in the Express Checkouts section to re-enable Apple Pay.
- Scrolling to the bottom and click Save Changes again.
- Clearing your browser cache.
- Test if the button appears afterward.
If the button still does not show up, check the error logs under WooCommerce > Status > Logs and see if there are domain registration related errors. If you see an error, it may be that the
apple-developer-merchantid-domain-association file is not publicly available from your domain root.
NOTE: In some cases, this can be caused by security plugins,
.htaccess rules, or web application firewalls that are in place at the server level. You can speak with your host to check on these and be sure they’re not preventing the file from being publicly available.
Adding the domain registration file manually
If WooPayments cannot automatically write the
apple-developer-merchantid-domain-association file to your server automatically, you can add it manually.
To upload this file:
- Download the file here.
- Use SFTP or SSH to upload it to the
.well-knowndirectory on your server.
- You may need to create a
.well-knowndirectory in the root directory of your site if none exists
- You may need to create a
The final location should be:
Once uploaded, follow the steps here to trigger domain registration again and see if the button appears afterward.
If the Apple Pay button is missing from only some locations, but not others (i.e., it appears on the Checkout page but not on the product page), this can happen for a number of different reasons:
- The product may not be compatible with express checkouts.
- Your theme may not support the necessary WooCommerce hooks, which are needed for Apple Pay to show up.
If you experience any other issues with Apple Pay, please take the following steps:
- Enable test mode and logging under Payments > Settings > Advanced settings.
- Attempt an Apple Pay transaction.
- Review the logs under WooCommerce > Status > Logs.
- If you see any errors, please get in touch with support and provide the logs for review.