Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewChoose your payments solutionGet started with payments
Online payments
Invoice integrations
Payment methods
Payment Methods OverviewGlobal
CardsAirwallex Pay
Apple Pay
Enable Apple Pay via web application
Enable Apple Pay using API
Hosted Payment PageEmbedded ElementsDrop-in ElementNative APIMobile SDKUse your own certificateEnable express checkoutTest your integration
Google Pay™
Klarna
Afterpay / Clearpay - BETA
PayPal
Skrill
EU & UK
APAC
NORTH AMERICA & LATAM

Enable Apple Pay using API

Airwallex supports enabling & activating Apple Pay as a payment method via API. Please note that you can either request Apple Pay along with other card payment methods or separately when at least one of the card payment methods is active on your merchant account.

If you are looking for steps to enable Apple Pay via our web application, then please find the details on this page

Enabling Apple Pay

You need to start with enabling Apple Pay as a payment method on your merchant account, you can use Enable a Capability API API to complete this step, endpoint is:

Code sample

JSON

X-on-behalf-of (header) : If you are a partner using our PA for platforms solution and you are enabling your connected accounts for a new payment method, then you need to use this in the header with the open identifier of the connected account.

Please ensure that you have configured ENABLE_ACCOUNT_CAPABILITY permission for all new connected accounts.

Activating Apple Pay

To activate Apple Pay as a payment option, you must complete this step if you are utilising your domain or not using Airwallex's hosted checkout solution for payment collection.

Before you activate You will need to host the domain verification file on your domain, see below steps:

  1. Download domain verification file : Apple provides a domain verification file which enables them to verify the associated domain during the registration process. You can download the file here

  2. Specify path to host file : Host the file at this path <<DOMAIN_NAME>>/.well-known/apple-developer-merchantid-domain-association on your site. While hosting this file, content-type should be set to application/octet-stream.

You can initiate this step by calling the Config API API by including the domain in the request body. You can add up to 99 domains in one request.

Code sample

JSON

Managing your Apple Pay domains

With Airwallex’s APIs, you can effortlessly manage your previously registered domains for Apple Pay. You can add new domains or delete the existing ones or just list them via our Config API API.

Add new domains

Same steps as explained in this section

Delete existing domains

Apple Pay allows a maximum number of 99 domains linked to a merchant account, it is recommended to delete any of the domains that are not active anymore. If you are not certain about all the domains that are currently registered on your account then you can use List API API and use the output to delete any of the domains that are not in use.

Get list of domains

Code sample

JSON

Delete domains

Code sample

JSON

Payments for platforms

If you are a partner using our Payment for platforms solution then you can manage the Apple Pay activation on behalf of your connected accounts. You can initiate the API requests with your own API key and specify the connected account identifier in the header of the API request. Connected account ID is required only when the connected account identifier will be the merchant of record for payments.

Steps explained in previous sections are applicable to platforms as well.

Code sample

JSON

If all of your connected accounts are using same domain or limited number of domains then you do not need to register all your connected accounts for Apple Pay, instead:

  1. You can register the domain / domains with your own (platform) details (without using x-on-behalf-of header with connected account identifier in the API request, see the sample here )
  2. You still need to enable the connected account for Apple Pay payment method as indicated in this step

FAQs

How do I register my payment processing certificate if I am using the iOS channel to collect payments?

It is currently not possible to upload your payment processing certificate via API, we are working on adding this capability soon. However, you can still manage this via our web application, please see detailed steps here

Are there any additional charges for using these APIs?

No, there are no additional charges for using these APIs

Is it necessary for each of my connected accounts to be registered under the same domain, even if we utilise a single domain for all connected accounts?

No, it is not required to go through domain activation steps for each combination of connected account & domain. You can manage this with single registration of domains with the platform details. However, you still need to enable Apple Pay as a payment method for all your connected accounts separately.

On this page