Apple Pay is a fast, easy, and secure way to pay accepted by over 85% of retailers in the U.S. Apple Pay enables users to add bank and credit cards to their phones for secure payments at stores. Card numbers are converted to unique, secure numbers stored on the phone's chip for safer transactions. Apple Pay replaces the need for customers to take a physical card or type in personal information during sales.
Apple Pay functionality is built into our existing platform requiring little-to-no development work, with three easy integration options for embedded payment options like PayFrame and PayFields and contactless payment terminals.
Compatibility
Apple Pay is compatible with Apple devices, Windows devices, and other devices in third-party browsers.
The minimum requirements for testing or accepting Apple Pay are:
Domain Registration
As a Partner, you can register one or multiple Merchants for Apple Pay using the Payrix Pro Portal. Domain registration involves providing each Merchant’s web domain to Apple for server call authorization, enabling transaction verification for Apple Pay. Host a file on your website for Apple to verify your domain, ensuring eligibility for Apple Pay integration.
An acceptable Merchant domain for Apple Pay is a public URL with a valid SSL certificate, using a secure HTTPS protocol.
The following sections guide you through the steps for enabling Apple Pay, including registration and domain whitelisting, for both single-merchant and multi-merchant enablement:
Initiate the Apple Pay Registration
Follow these steps to initiate the Apple Pay registration for your Merchants domains linked to each Merchant’s website.
Access the Payment Methods page from Settings.
Click Enable on the Apple Pay panel to initiate the registration process by configuring the domain.
Configure the Domains
Here, you’ll need to configure each domain and register it with the Apple Pay service. This is a crucial step in validating the Merchant for future transactions, ensuring the security of both the Merchant and the cardholder.
Important!
You must meet the following Apple Pay domain configuration requirements:
Your website URL must be publicly accessible and cannot be set to
localhost
.Your website must begin with
https
and have a valid SSL certificate for secure communication.
Download the domain association file: Sandbox | Production
Host the file here:
{baseURL}/.well-known/apple-developer-merchantid-domain-association
Result: After you successfully hosted the domain configuration file and have the domains you need to register with the Apple Pay service, proceed to the Enter Domain section.
Provide Merchant Domains for Registration
After completing the steps above, the Apple Pay service will search each website's specific URL path: (/.well-known/apple-developer-merchantid-domain-association
)for the matching file once the registration is initiated from the Payrix Pro Portal.
Consider how your Apple Pay setup is structured before providing the Merchants’ domains. Apple requires each domain that processes Apple Pay payments is linked with the correctly registered merchant ID. The following table outlines common domain and merchant configurations to help you determine which domains to register:
Registration Use Case | Description | Example |
---|---|---|
One Merchant, One Domain | One merchant processes Apple Pay on one domain. This is the most straightforward setup and requires a single domain to be registered to one Merchant ID. | Merchant A uses checkout.example.com to process Apple Pay payments. |
One Merchant, Multiple Domains | One merchant uses Apple Pay across multiple domains. You must register the Merchant ID to multiple or all domains to allow payment session verification of the domain against the Apple Pay service’s approved domain list. | Merchant A uses shop.example.com, pay.example.com, and checkout.example.com to process Apple Pay payments. |
Multiple Merchants, One Domain | Merchants share a domain for payment processing. You must register each Merchant ID with the same domain to prevent Apple Pay from rejecting transactions due to mismatched IDs. | Merchants A, B, and C use checkout.example.com to process Apple Pay payments. |
Your domain registration file can include a variety of registration scenarios. The following table provides an example of how domains and merchant IDs can be linked:
domain | merchant_id |
---|---|
shop.example.com | p1_mer_123abc4d567890efg1h2i34 |
pay.example.com | p1_mer_123abc4d567890efg1h2i34 |
checkout.example.com | p1_mer_123abc4d567890efg1h2i34 |
checkout.example.com | p1_mer_234bcd5e678901fgh2i3j45 |
checkout.example.com | p1_mer_345cde6f789012ghi3j4k56 |
In this scenario, one Merchant using one domain, one Merchant using multiple domains, multiple Merchants using one domain.
Bulk Upload (CSV)
Bulk Upload allows you to upload a pre-configured CSV file containing domain and Merchant ID pairings. The registration system selects and registers each merchant listed in the CSV file upon completing the Register the Domains with Apple Pay steps.
To upload your CSV file and register your included merchants for Apple Pay:
Select Bulk Upload (CSV) from at the top of the page.
Click the Template File Download button for a CSV file to add each applicable domain.
Add the applicable Merchant domains to the domain column.
Important!
Remove the
https://
scheme from any domain column values in your CSV file. Domains that include this scheme fail the registration process.Using the Template File Upload prompt, upload your completed CSV file to the Payrix Pro Portal.
Click Continue to proceed to the Register with Apple Pay section.
Result: All domains and their associated Merchant IDs have been successfully uploaded to the Payrix Pro Portal and you can now register them with the Apple Pay service.
Tip
We recommend downloading your true domain registration file from the Payrix Pro Portal because it is pre-populated with your portfolio’s Merchant IDs.
For a blank template, download this sample Bulk Upload CSV file:
Register the Domains with Apple Pay
When you click the Register button shown on the Register with Apple Pay section, each domain registration file uploaded to the provided domains is compared against the domains provided to Payrix Pro. Apple Pay verifies each domain by cross-referencing files, which completes within seconds.
After completing registration, an on-screen notification is displayed based on your method of enablement:
Merchant registration process is complete.
Your Merchants are now able to start accepting Apple Pay payments.
Enabled: # | Failed: # | Pending: #
Manage Your Merchant Apple Pay Registrations
When onboarding new merchants to your portfolio, you must register each one for the Apple Pay service. Select Payment Methods from the Settings page to access the Apple Pay Registration management dashboard. This dashboard offers a simplified registration process, allowing you to manage registrations seamlessly without causing any interruptions to the operations of previously registered merchants.
Tip
To register newly onboarded Merchants or another existing, non-registered Merchant to domains you’ve already configured, bypass the domain configuration step. Instead, update and re-upload your domain registration CSV file with the new Merchant information.
Note
To register a new domain, you’ll need to perform the above steps again, including configuring domain configuration, providing and registering the domain.
The Apple Pay registration table shown in the Payment Method section of Settings, allows you to see a consolidated table of Merchants that have successfully been registered, Merchant IDs, their associated domains, and their Apple Pay enablement status:
Registration Status | Status Description | Action Button | Action Description |
---|---|---|---|
Enabled | A successful Merchant domain and Apple Pay registration. | Disable | Disable the Merchant’s Apple Pay registration/availability. |
Failed | A Merchant domain and Apple Pay registration were unsuccessful. | Retry | Re-attempt a registration that received a Failed status and/or Failure message. |
Pending | Merchant domain and Apple Pay registration is in progress. | n/a | n/a |
Disabled | Previously successful Merchant registration, for Apple Pay service was successful, but has been or was recently disabled. | Enable | Register a Merchant that has not previously been registered for Apple Pay, or re-register a previously Disabled Merchant Apple Pay registration. |