Apple Pay™

Frictionless payments for customers with Apple devices

Overview

Apple Pay offers a secure and frictionless way for customers to pay using their Apple devices. Key advantages include:

One-tap payments with stored cards
Built-in biometric authentication
Support for recurring and one-click payments
High security with tokenization
Improved conversion with seamless UX
Available across iOS, iPadOS, and macOS devices

Features

Available integrations

Payment Link Payment Component

Payment typeMobile

Supported channels

OnlineIn-person

Transaction currenciesEURUSDGBP

Settlement currencies11+ supported payout currencies

Settlement typeNet

Merchant countries

European Economic Area

Supported browsersSafari

Supported OSiOS 13.0+, iPadOS 13.0+, macOS 10.15+

Capabilities

Refunds

Partial refunds

Multiple partial refunds

Final amount captured later

Multiple partial captures

Incremental authorizations

3D Secure

Disputes

Recurring payments

Account top ups

Split payments

Currency exchange

When integrating Apple Pay with Payment Components, domain registration is required to verify domain ownership and ensure secure transactions. This is a one-time setup process that typically takes 15-30 minutes to complete.

Who needs to register domains? - If you're a Platform integrating the Payment Component on your own domain(s), you only need to register those domains once - If your Merchants are integrating the Payment Component directly on their domains, each Merchant domain needs to be registered - For Merchant domain registration, we recommend Platforms handle this process via API on behalf of their Merchants to ensure a smooth setup

For detailed browser and device requirements, refer to Apple Pay on the Web.

Prerequisites

Before starting the domain registration process, ensure you have:

Access to modify your domain's web server configuration
HTTPS enabled on your domain (required for all Apple Pay integrations)
API keys for your Platform account

Your domain must meet Apple's requirements for accepting Apple Pay payments. See Setting Up Your Server to Accept Apple Pay Payments for detailed requirements, including:

Valid SSL certificate from a trusted certificate authority
Domain ownership verification
Proper server configuration for serving the domain association file

Step-by-Step Registration Process

Step 1: Generate Domain Verification File

First, generate the domain verification file that Apple will use to verify your domain ownership:

Request
POST
/v2/account/saveAppleAccountDetails
 {
   "accountId": "3121002101246004517345bd081",
   "domainNames": ["https://merchant.com"]
 }
Response
  {
    "domainVerification": "7b2276657273696f6e223a312c227073704964223a2238363231353444423245414331433234343635364146464333303733454444363941303042394642324346353641464344353442444436394339453941413035222c22637265617465644f6e223a313732343834373138353038377d",
    "locations": [
      "https://merchant.com/.well-known/apple-developer-merchantid-domain-association"
    ]
  }

Step 2: Host the Verification File

Create a .well-known directory in your web server's root directory
Save the verification file as apple-developer-merchantid-domain-association (no file extension)
Place the file at: https://{your-domain}/.well-known/apple-developer-merchantid-domain-association

The file must be accessible via HTTPS - No redirects are allowed - The file must be accessible on all subdomains where you plan to accept Apple Pay - The file content must be served without any modifications or encoding

Step 3: Register Account with Apple Pay

Once the verification file is properly hosted, register your account with Apple Pay:

Request
POST
/v2/payment-profile/registerAccountWithApplePay
 {
   "accountId": "3121002101246004517345bd081"
 }
Response
 "3121002101246004517345bd081"

Subdomain Support

If you need to accept Apple Pay on multiple subdomains:

Host the verification file on each subdomain
Include all domains in the domainNames array when calling the API
Each domain must be HTTPS-enabled
Wildcard domains are not supported

Example domains configuration:

{
  "domainNames": [
    "https://merchant.com",
    "https://checkout.merchant.com",
    "https://store.merchant.com"
  ]
}

Verification and Troubleshooting

To verify your domain registration:

Check that the verification file is accessible via HTTPS
Ensure the file content matches exactly what was provided
Verify there are no redirects in place
Test the Apple Pay button on your domain

Common issues:

File not accessible via HTTPS
Incorrect file permissions
Redirects interfering with file access
File content modified by server configuration

For Platforms managing multiple merchants: You can either handle domain registration via API on behalf of your merchants, or allow merchants to self-configure through the Dashboard. The process remains the same, but you'll need to use the merchant's account ID when making the API calls if managing it on their behalf.

Integration

Enable Apple Pay in your payment profile and proceed with your preferred integration method:

Testing on Sandbox

Use Safari browser on an Apple device
Add test cards to Apple Wallet from the test card numbers page

Available Test Cards:

Scheme	Test card number
Mastercard	5204 2452 5046 0049
Mastercard	5204 2452 5052 2095
Visa	4761 1200 1000 0492
Visa	4761 3497 5001 0326

Go live checklist

Payment Profile

You have enabled Apple Pay in your Payment Profile
You have enabled the right transactions type for your use case (e.g. Pre-authorization, One-off, Recurring)

Domain registration

You have successfully registered your domain with Apple Pay
You have configured the domain verification file on a public path on your domain
You have completed the Account Registration step in the Dashboard

Learn more about available features in our Payment Features Overview.