Log inGet started
Airwallex logo
Home
Online Payments
Treasury
Transactional FX
Payouts
Issuing
Scale
Open Banking
Developer Tools
API Reference
Home
Online Payments
Overview
Starting with paymentsAirwallex platform overviewOnline payments modelPricing model
Payment Methods
OverviewGlobalEU & UKAPAC
APAC Regional
Atome
Desktop/Mobile Website Browser
AustraliaChinaHong KongIndonesiaJapanKoreaMalaysiaPhilippinesSingaporeThailandTaiwan
US & LATAM

Desktop/Mobile Website Browser

Accept Atome payments on your website by redirecting the shopper to Atome.

See checkout process below:

  1. The shopper chooses to pay with Atome on the checkout page.
  2. The shopper is redirected to Atome authentication page where they log into their Atome account.
  3. The shopper completes the payment.
  4. The shopper is redirected to the return URL you designated.

Step 1. Initialize a payment Intent

Create a PaymentIntent object with a request_id, amount, currency and a merchant_order_id from your backend server. Please note that the product and shipping parameters are also required for risk scanning purposes on the Atome side.

Step 2. Get available payment methods

To be able to display Atome as an option on your checkout page, you need to get available payment methods from Airwallex API.

When the PaymentIntent is created, send a GET request with parameters country_code, transaction_currency, transaction_mode to API endpoint /api/v1/pa/config/payment_method_types to query for a list of available payment method based on the information provided. The response will also contain the required fields and necessary resources of each payment method for you to display them on your page.

Request:

Shell

Response: Render payment methods in items to show all available payment methods to the shopper at checkout page.

Shell
Note:

Alternatively, you can maintain available payment methods and corresponding resources locally on your server if you do not want to use this API endpoint. However, we highly recommend you get available payment methods dynamically from this API to avoid any trouble when payment method information or resources get updated.

Step 3. Redirect to Atome to complete payment

When a shopper selects to pay with Atome on their desktop/mobile browser, call the following API endpoints to get the URL which you can use to redirect the shopper to Atome pages to complete the payment.

1. Obtain URL from Airwallex and redirect shopper to Atome

Request:

Note:

The shopper_phone should be formatted in E.164 standard. E.g. Singapore phone number +6580001500

Response:

Shell

2. Wait for notification from Airwallex

Airwallex will notify you on the payment result asynchronously via the webhook API. Please refer to webhook documentation to set up your webhook accordingly. Although subscribing to different events is optional, it is recommended to at least subscribe to the ‘payment_intent.succeeded’ which indicates that the shopper has successfully paid for the order via Atome.

3. Query the PaymentIntent status

You may also query the status of a payment anytime via the PaymentIntents API

Shell