Payment-method icon

Alipay for API only

Add Alipay to an existing API-only integration.

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.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Setup steps Before you begin, add Alipay in your test Customer Area.

Build your payment form for Alipay

Include Alipay in the list of available payment methods. You do not 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:

The response contains paymentMethod.type: alipay for Web, or alipay_wap for iOS and Android.

Make a payment

In your /payments request, specify:

  • paymentMethod.type:

    • 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.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

    • When using the HTTP GET method:
      For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

    • Redirection for mobile integrations:
      For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

  2. 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 redirectResult returned when the shopper was redirected back to your site.

  3. In the response note the following:

    • resultCode: use this to present the result to your shopper.
    • pspReference: our unique identifier for the transaction.

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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 have 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.

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

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:

  1. Get an Alipay wallet app, set it up with a credit or debit card, and do live penny tests (payments for a minimal amount).
  2. 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.

See also