You don't need to collect any information from your shopper in your payments form. If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the Alipay app or website where they can complete the payment.
When making an Alipay payment, you need to:
Before you begin
This page explains how to add Alipay to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.
Before starting your Alipay integration:
- Make sure that you have set up your back end implementation for making API requests.
- Add Alipay in your test Customer Area.
Show Alipay in your payment form
Include Alipay in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
- Specify in your /paymentMethods request:
The response contains
We provide logos for Alipay which you can use on your payment form. For more information, refer to Downloading logos.
Make a payment
When the shopper proceeds to pay, you need to:
From your server, make a /payments request, specifying:
paymentMethod.type: Set this to alipay_wap.
returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the
RedirectComponent.getReturnUrl(context). This URL can have a maximum of 1024 characters.
The /payments response contains an
actionobject with the information needed to redirect the shopper.
- Pass the
actionobject to your client app. You need this to initialize the Redirect Component.
Handle the redirect
Use the Redirect Component to redirect the shopper to Alipay.
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
actionComponentData.detailsobject from the Redirect Component.
You receive a response containing:
resultCode: Use this to present the payment 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.