Guest user checkout
This page describes how to embed a Apple Pay Element on your payment page to accept payments.
How it works
The diagram below depicts the information flow in a Apple Pay Element integration.
Before you begin
Before you implement the integration, consider the following:
Ensure your Airwallex account is activated for online payments.
Obtain your access token API by authenticating to Airwallex using your unique Client ID and API key. You will need the access token to make API calls.
Step 1: Set up the server to create a PaymentIntent
When the shopper begins the checkout process, you will need to create a PaymentIntent object to indicate your intent to collect payment from the shopper.
When the checkout page loads, on your server, call Create a PaymentIntent API with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious shoppers from being able to alter the payment amount.
Provide return_url in Create a PaymentIntent API to indicate where Airwallex should redirect the shopper after completing the payment, whether successful or otherwise.
The PaymentIntent’s id and client_secret are returned in the response — these parameters let you confirm the payment and update card details on the client, without allowing manipulation of sensitive information, like payment amount.
Step 2: Initialize Airwallex on your checkout page
First, you will need to import Airwallex.js and then initialize the package. For details, see Initialize Airwallex JS.
Step 3: Add the Apple Pay Element to your checkout page
To embed the Apple Pay Element into your checkout page, you will need to create an empty container, create the Element and then mount the Element to the container.
Define the payment form
First, create an empty container div with a unique id in your payment form. Ensure that the payment form only contains one Element with this unique id. Airwallex inserts an iframe into this div on mounting the Element.
Create the Apple Pay Element
When the payment form has loaded, call createElement(type, options) by specifying the Element type as applePayButton to create the Element. Ensure that the payment form only contains one Element with applePayButton id.
Mount the Apple Pay Element
Call mount() with the id of the div to mount the Element to the DOM. This creates the Apple Pay button. The Element should only be mounted once in a single payment flow.
Add onReady event listener to ensure the Element is mounted. Use this event to prepare and load the checkout page.
Apple Pay props
You can also pass options in createElement() to overwrite styles and other functions as shown in the following table. For details, see applePayButton props JS.
Step 4: Handle the response
Add success and error event listeners to handle error and success events received from Airwallex.
If no error occurred, display a message that the payment was successful. If payment fails with an error, display the appropriate message to your shopper so they can take action and try again.
Retrieve the payment result
For any actions subsequent to the payment such as shipping goods or sending email receipts, you can retrieve the payment result using the following options:
Set up webhooks to receive notifications on whether the payment has succeeded. Airwallex sends
payment_intent.succeededevent when a payment succeeds. Listen to these events rather than waiting on a callback from the client. On the client, the shopper could close the browser window or quit the app before the callback executes. For information on how to set up webhooks and listen to events, see Getting started with webhooksOn your server, call Retrieve a PaymentIntent API to check the PaymentIntent status.
Check Payment Activity screen on your Airwallex web app.
Test your integration
Perform transaction tests in the production environment as described in the go-live checklist to ensure your integration is working correctly.