Online payment acceptance
Partners such as payment orchestrators can facilitate online payment acceptance for their connected accounts through Airwallex. To build such an integration, you will need the following OAuth Scopes:
w:awx_action:pa_editr:awx_action:pa_view
On a case-by-case basis, partners who have good reasons why Oauth is not acceptable for their use-case may be approved to use API keys instead of Oauth for this purpose. Please reach out to [email protected] if you require using API keys instead of Oauth.
You will also need to choose which integration type you would like to use. For payment orchestrators, we generally recommend either Native API or Embedded Elements, depending upon whether you are PCI-DSS compliant or not.
Prior to facilitating payments with any Airwallex merchant, please ensure that their account is connected and they have passed all KYC/KYB steps such that their account is active and the relevant payment methods are enabled on their account. A merchant’s enabled payment methods can be verified either through the webapp or through native API calls API.
Regardless of the integration type you choose, please ensure you pass the following information to Airwallex during payment intent creation and confirmation in order to maximise success rates:
- Customer (email + customer name)
- Product information
- Shipping information
- Billing information
Further details on how to pass the above information is available here .
Details on how to integrate with Native API and Embedded Elements are provided below.
Native API Integration
A Native API integration is permitted only for partners with PCI-DSS certification; a Report on Compliance (ROC) must be provided to enable this. You can email [email protected] with your Report on Compliance to get enabled for Native API access.
It’s essential that Airwallex is able to identify which partner is making native API calls on behalf of any merchant. Otherwise, the API calls may be blocked. To identify yourself to Airwallex, you will need to populate a field called referrer_data.type within your API request with an Airwallex-provided value. Additionally, you will need to do one of the following:
- If you are using static IP addresses, get Airwallex to whitelist these IP addresses for native API access. Please note that these IP addresses must be specific to your company, and not shared across multiple companies (i.e. certain IP addresses provided by public cloud services).
- Alternatively, if you are using a unpredictable IP addresses, you will need to include an additional Airwallex-provided secure token in your API request.
To perform IP whitelisting, to obtain the secure token, or to obtain the referrer_data.type value, you can email [email protected].
You will also need to integrate with 3DS. Airwallex recommends integrating with Airwallex 3DS in order to provide the best possible experience. However, for partners who must use external 3DS, external 3DS integrations are also supported . In addition to 3DS, we require that you implement device fingerprinting for fraud prevention.
To complete your Native API payment acceptance integration, please refer to the below documents and diagram.
Apple Pay Native API Documentation
Google Pay Native API Documentation
Embedded Elements Integration
For partners not integrating with Native API, Airwallex provides pre-built “Elements” that can be embedded into your experience with less effort. The Drop In Element provides a full-featured checkout module, which lets you accept multiple payment methods easily. For a more customized experience, you could choose instead to use more granular Embedded Elements , such as the Card Element, Split Card Element, Apple Pay Button Element, and Google Pay Button Element, rather than an all-in-one solution. For further details on how to integrate, please refer to the below documents and diagrams:
Introduction to Drop In Element
Introduction to Embedded Elements
Introduction to Airwallex.js SDK
