Skip to main content

Apple Pay Integration

Enable secure, contactless payments using Apple Pay on iOS devices, Mac, and Safari browser with biometric authentication for seamless checkout.

This guide walks you through adding Apple Pay to an existing Connected Payments payment page. There are three stages:

  1. Onboarding — host a verification file and register your domain(s)
  2. Enabling Apple Pay — turn on Apple Pay for your payment page
  3. Adding the button — insert the Apple Pay button into your page config

Onboarding​

Before you can accept Apple Pay payments, Apple requires you to prove you own the domain(s) you want to accept payments on. This is a two-step process.

Before you begin

Make sure you have the ability to host a static file on the domain(s) you intend to use for Apple Pay. Without this, onboarding cannot be completed.

Step 1 — Host the Apple Pay verification file​

Apple requires a specific file to be hosted at a fixed path on your domain. The path must be exact — any deviation will cause the verification to fail.

Required path:

/.well-known/apple-developer-merchantid-domain-association

So if your domain is example.com.au, the file must be accessible at:

https://example.com.au/.well-known/apple-developer-merchantid-domain-association

Download the verification file:

Download apple-developer-merchant-id-domain-association
Important hosting requirements
  • The file path must return a 200 OK response — no redirects
  • The file must not be removed once hosted
  • Do not rename the hosted file — the path is what matters, not the filename

Step 2 — Verify the file and register your domain(s)​

Once the file is live, verify it and register your domain(s) via the Connected Payments dashboard.

Navigate to the Apple Pay Domain Verification option and complete the form:

FieldWhat to enter
Domain namesAll domains where you want to accept Apple Pay. If using a hosted payment page or embedding via iFrame, include the domain used to render the iFrame (e.g. payments.connectedpayments.com.au).
Merchant URLA valid URL to your primary website that owns all other domains.
Customer IDYour customerId value — pre-filled if detectable. If not, enter it exactly as configured. This field is case sensitive.
Need help?

If you run into errors during domain verification, email [email protected] with the subject prefix "Apple Pay domain verification:" and include your customer ID or business name.

Enabling Apple Pay​

Once onboarding is complete, enable Apple Pay on your payment page:

  1. Open the payment page you want to update in the Connected Payments dashboard (or ask CommBank to do this for you).
  2. Go to the 3rd Party Integrations tab.
  3. Toggle Apple Pay on.
  4. Fill in the configuration form that appears with your preferences.

Adding the Apple Pay Button​

With Apple Pay enabled, add the button to your page by inserting the following JSON object into your page config at the position where you want the button to appear:

{
  "applePayTag": "applePayButton",
  "class": "apple-pay-button"
}
iFrame embed

If your payment page is embedded inside an iFrame on a parent page, ensure the <iframe> element includes the allow="payment" attribute:

<iframe src="..." allow="payment"></iframe>