Log inGet started
Airwallex logo
Online Payments
Transactional FX
Open Banking
Developer Tools
API Reference
Online Payments
Starting with paymentsTransaction and settlement modelPricing model
Integration options
Integration OverviewPayment LinksPayment Links API
Hosted Payment PageEmbedded ElementsDrop-in ElementMobile SDKNative APIPlugins

Payment Links API

Create payment links at scale with the API and embed it into your sales processes.

Link the Payment Links API API to your internal systems for a payment link to be generated every time a new order comes through, a new invoice gets sent out, or whenever you email a new customer. You can automatically create links with the API that support the full feature set as the webapp version.

Enjoy the same benefit of accepting payments via 30+ payments methods in any currency from anywhere in the world, as well as top tier fraud protection and 3D secure authentication.

For more information on how to create payment links with the webapp, refer to the Payment Links page .

Step 3: Track payments

When customers complete a payment on a payment link, Airwallex sends a payment_intent.succeeded webhook that you can use for subsequent fulfillment and reconciliation purposes. See Notifications and Webhooks for more information.

Error Processing

In general, all API calls can be failed and in this case, merchants will get a specific HTTP status and error code and error message in the body.

Error codeError description
OTHER_ERRORsome other errors, it should contain trace-id in the message for debug
INPUT_MISSINGrequested input field is missing
INPUT_TOO_LONGrequested input field is too long
CODE_BAD_SYMBOLSrequested code had unsupported symbols
CODE_NOT_FOUNDrequested code not found
CODE_NOT_UNIQUErequested code not unique in the system
EMAIL_NOT_VALIDrequested shopper email is not valid or is too long
BAD_EXPIRYexpiry date in the past
ACTIVATION_FAILEDcan't activate link (current status not DEACTIVATED)
DEACTIVATION_FAILEDcan't deactivate link (current status not ACTIVE)
INTENT_CREATEDintent already created for one-time links
LINK_FORBIDDENlink belongs to another merchant
LINK_NOT_FOUNDlink not found
LINK_NOT_ACTIVElink not active
CONFIG_NOT_FOUNDmerchant config not found
CORE_FAILEDpayment core failed to create intent
CONFIG_CENTER_FAILEDconfig centre failed to provide merchant available currency
AMOUNT_WRONGrequested amount is wrong (less than min or other currency)
MERCHANT_NOT_ENABLED_PAmerchant config is not full in config-centre or no active PMPs configured
HEADER_MISSINGmissing required header
ARGUMENT_MISMATCHfailed to deserialize JSON from the body
On this page