Platform Features
and e-commerce platforms. Discover the benefits,
enablement steps, and resources to get started.
Apple Pay Web Merchant Registration API
Onboard merchants at scale
for Apple Pay on the web
The Apple Pay Web Merchant Registration API empowers platform integrators, including payment service providers (PSPs) and e‑commerce platforms, to offer simplified setup for merchants enabling Apple Pay on the web. Register merchants with their own website domains or with webpages hosted on your domain.
Streamlined merchant integration
Reduce operational costs and fast‑track your workflow by onboarding and managing multiple merchants simultaneously — with no extra effort on their end.1 The Web Merchant Registration API allows you to support all web integrations, seamlessly enabling merchants across standard payment pages, iframes, in‑app web views, direct APIs, and JS SDKs — whether they use their own website domains or work pages hosted by your platform.
Encryption options for payment data
Platforms can either decrypt the Apple Pay data themselves, or encrypt Apple Pay data directly to a downstream PSP or processor. This enables platforms to pass transactions along securely without needing to decrypt the sensitive payment data.
Get started.
Enable the Apple Pay Web Merchant Registration API
- Partner with us.
- Enroll your organization in the Apple Developer Program.
- Get familiar with the Apple Pay APIs and integration process by reading the Apple Pay Platform Integration Guide. An overview of the register merchant process is provided in the diagram below. Note: The Apple Pay Web Merchant Registration API is only for Apple Pay on the web; it is not available for native app integrations.
- Request access to the Apple Pay Web Merchant Registration API. Refer to Registering with Apple Pay and Applying to Use the API. Approval is subject to review by Apple. Your designated Apple Developer Account Holder will receive an email from Apple with the decision.
- Integrate the Apple Pay Web Merchant Registration API using best practices.
Review best practices. - Configure identifier(s) and certificate(s).
- Integrate the Apple Pay Web Merchant Registration API.
- Test using the Apple Pay Sandbox environment.
- Begin onboarding merchants.
Explore the resources
Frequently asked questions
The Apple Pay Web Merchant Registration API allows platform integrators such as payment service providers (PSPs) and e‑commerce platforms to onboard and manage merchants at scale with a simple API call, allowing them to offer Apple Pay on the web.
The Apple Pay Web Merchant Registration API only works with Apple Pay on the web, or for web integrations via a webview in an app. It cannot be used with native app integrations.
Yes, platforms need to enroll in the Apple Developer Program. Refer to Become a member — Apple Developer Program and the Apple Developer Program License Agreement to get started.
After the Apple Developer Program Account Holder requests access to the Apple Pay Web Merchant Registration API, Apple will review and notify them by email with the decision. Refer to Registering with Apple Pay and Applying to Use the API for more details.
Yes, each merchant should review and agree to the Apple Pay Platform Web Merchant Terms and Conditions before enabling Apple Pay. The optimal way for platforms to manage this is by embedding these terms within their wider service agreement for new and existing merchants. The PSP or platform is responsible for obtaining and capturing consent to these terms.
Refer to Apple Pay Web Merchant Registration API and Apple Pay Platform Integration Guide to get technical guidance on how to implement the API.
This feature can be enabled as part of a new or existing Apple Pay implementation. As with other Apple Pay features, Apple does not charge implementation fees for its enablement.
Any platform that offers e‑commerce services or web payments to multiple merchants is eligible for the Apple Pay Web Merchant Registration API. This could be an e‑commerce platform, shopping cart solution, or PSP.
No, there is no limit to the number of merchants who can be registered via the Apple Pay Web Merchant Registration API. Note: there is a maximum limit of 99 domains for each merchant partnerInternalMerchantIdentifier. All subdomains need to be verified in production.
Yes. unregisterMerchant is the request to unregister merchant domains. When integrating the Apple Pay Web Merchant Registration API, refer to additional information and properties at UnregisterMerchantRequest and Unregister Merchant Web Service Endpoint.
- Both Payment Processing certificates and Platform Integrator Identity certificates expire every 25 months. Developers can log in to their Apple Developer account to view certificate expiration dates or use the App Store Connect API to retrieve certificate information.
- As the expiration date approaches for certificates, Apple sends an email reminder to the Apple Developer Account’s Admin and Account Holder. Organizations should continuously monitor the inbox of these users and renew certificates before expiration to avoid Apple Pay service interruptions.
- Payment Processing certificates can be updated via the Apple Developer account or the App Store Connect API; Platform Integrator Identity certificates can be updated via the Apple Developer account.
Yes, platforms can programmatically check certificate expiry dates as well as create, rotate, and revoke Payment Processing certificates via the App Store Connect API. This is recommended as best practice when implementing the Apple Pay Web Merchant Registration API.
Before sending the registerMerchant request, each domain included in the request will need to host the domain verification file and make it accessible to the Apple Pay servers. For more information, refer to Preparing Merchant Domains for Verification.
Yes, a merchant can be registered via the Apple Pay Web Merchant Registration API by multiple platforms and have an active processing setup with each partner at the same time. The merchant will need to ensure they use the correct domain verification file at the point of registration by each partner. Once registration is complete there is no need for a merchant to continue hosting this file.
When performing a transaction, merchants must use the payment configuration and relevant processes specific to the platform partner they wish to complete the transaction.
The Apple Pay Web Merchant Registration API is available in Apple’s sandbox environment for testing. To use the sandbox environment, send requests to the apple-pay-gateway-cert.apple.com endpoint. For example, to register a merchant in the sandbox, platforms should send their request to: POST https://apple-pay-gateway-cert.apple.com/paymentservices/registerMerchant. To learn more, go to Apple Pay Web Merchant Registration API.
If a merchant is found to violate the Acceptable Use Guidelines for Apple Pay on the Web, the platform may be notified and expected to resolve it. If the merchant is no longer actively using Apple Pay through your platform, you should promptly unregister them via the unregisterMerchant request.
Join the Apple Pay platform.
Best Practices
- Provide merchants a simple, self‑service way to prepare and register their own domains. Be sure to include the following:
- The ability to download the domain verification file for your platform.
- Instructions on how to prepare merchant domains, including how and where to host the domain verification file.
- A way for merchants to supply the list of domains that they want to register for use with Apple Pay.
- Automate certificate renewal when implementing the Apple Pay Merchant Registration API. Programmatically check payment processing certificate expiry dates as well as create, rotate, and revoke this certificate via the App Store Connect API.
- Check that the domain(s) are prepared prior to sending a merchant registration request. To prevent errors, ensure the domain is reachable, returns the expected response, and that the correct domain verification file is returned before sending the registerMerchant request.
- Monitor responses from Apple Pay servers for any error messages. These can indicate that there is something wrong with a request, and should be used to inform the merchant of any action required to be successful.
- Unregister merchants who no longer use Apple Pay via your platform. Platforms should unregister merchants who no longer use Apple Pay on their platform. Apple Pay periodically checks registered merchant domains for violations against the Apple Pay Acceptable Use Guidelines; if a merchant remains registered to your platform you may be notified of, and expected to resolve, any violations which occur in the future, even if the merchant is no longer using Apple Pay via your platform.
More resources
Apple Pay Demo
in an interactive playground.
Apple Developer
build apps for Apple platforms.
Apple Business
presence across Apple apps.
-
1. Integrations where the merchant hosts the page offering Apple Pay may require the merchant to host a domain verification file to complete Apple Pay setup.
-
In the US, Apple Pay is a service provided by Apple Payments Services LLC, a subsidiary of Apple Inc. Neither Apple Inc. nor Apple Payments Services LLC is a bank. Any card used in Apple Pay is offered by the card issuer.
-
Apple Pay is not available in all markets. View Apple Pay countries and regions.
-
Features are subject to change. Some features, applications, and services may not be available in all regions or all languages and may require specific hardware and software.