Accept Alipay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Alipay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Alipay integration:
Build your payment form for Alipay
Include Alipay in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for Alipay which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: The country where the shopper is, in this case a supported country outside of China, for example NL.
- amount.currency: Any supported currency. For example, EUR. See Processing currencies for ecommerce for more information.
- channel: Specify Web, iOS, or Android.
The response contains
paymentMethod.type: alipay for Web, or alipay_wap for iOS and Android.
Make a payment
In your /payments request, specify:
- alipay for Web, to use the desktop flow where the QR code displayed on the website.
- alipay_wap for iOS and Android, to redirect to the mobile app.
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for Alipay are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful.
You will receive the funds in 3 days.
|Cancelled||The shopper canceled the payment while on the Alipay website.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Pending or Received||The shopper has completed the payment but the final result is not yet known.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
|Refused||The payment was refused by the shopper's bank.||Ask the shopper to try the payment again using a different payment method.|
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful and proceed with the order.|
Test and go live
We recommend doing live penny tests:
- Get an Alipay wallet app, set it up with a credit or debit card, and do live penny tests (payments for a minimal amount).
- View the details of your Alipay test payments in your live Customer Area > Transactions > Payments.
Before you can accept live Alipay payments, you need to submit a request for Alipay in your live Customer Area.