Alipay Payments

Alipay is an e-wallet used in China that allows customers to purchase goods online using their Alipay balance or by selecting a payment method from the wallet.

Alipay is a supported browser payment method in the Mastercard Payment Gateway. This page describes integration details specific to Alipay. It's recommended that you read the integration guidelines for browser payments, before building an Alipay integration.

Alipay browser payments are supported for transactions in currencies — AUD, CAD, EUR, GBP, HKD, SGD, USD.

Note that the gateway only supports Alipay for cross-border merchants, i.e., international merchants entering the Chinese market and Chinese tourists abroad that want to pay with Alipay. The gateway does not allow processing CNY natively for Chinese-domiciled merchants.

In the case of cross-border merchants:

  • The order amount will be presented to the payer (by the gateway) in the processing currency (e.g. EUR).
  • The payer will be debited by Alipay in CNY and will be charged for the currency conversion.
  • The merchant will be settled by the browser payments service provider in EUR.

Prerequisites

To offer Alipay as a payment method via the Mastercard Payment Gateway:

  • You must be registered with your browser payments service provider.
  • Your merchant profile on the gateway must be configured using the details of your account with the browser payments service provider.
  • You must have a bank account in one of the supported currencies registered against your merchant account at your browser payments service provider.

Alipay Integration

Alipay via Hosted Checkout

With Hosted Checkout integrations version 51 and later, Alipay is automatically available to your payers when you are enabled and configured for it by your payment service provider.

For details, see Browser Payments via Hosted Checkout Integration.

Alipay via Direct Payment

Direct Payment integration allows you to offer Alipay payment method on your own checkout page.

Alipay is supported from API version 45 onwards.

Make an Initiate Browser Payment request where sourceOfFunds.type = ALIPAY and browserPayment.operation = PAY (the Authorize operation is not supported by Alipay). For the standard fields, see Browser Payments via Direct Payment Integration.

Preferred Language

You can set the language that you prefer Alipay to use for pages displayed to the payer by providing the browserPayment.preferredLanguage field in the Initiate Browser Payment request. However, the language will be used only if Alipay supports it.

Sample Code to Initiate Alipay Payment
{
    "apiOperation":"INITIATE_BROWSER_PAYMENT",
    "browserPayment":{
      "operation":"PAY",
    "returnUrl":"https://<return_url>"
},
    "order":{
        "amount":"10.00",
        "currency":"GBP"
        },
        "sourceOfFunds":{"type":"ALIPAY"
        }
}

How to Interpret the Transaction Result

The table below shows the transaction response codes for the possible scenarios you may encounter after initiating an Alipay payment.

Initiate Browser Payment Response
 What This Means...
response.gatewayCode=SUBMITTED
result=SUCCESS		 Redirect the payer using the URL provided in the response.
Retrieve Transaction/Retrieve Order Response
What This Means...
response.gatewayCode=APPROVED
result=SUCCESS		 The payment is successful.
response.gatewayCode=PENDING
result=PENDING
 The Mastercard Payment Gateway is waiting for a notification from the acquirer about the payment result. Try RETRIEVE_TRANSACTION again later or listen to notifications from the gateway.
response.gatewayCode=CANCELLED
result=FAILURE		 The payer has cancelled the interaction for this payment. Offer the payer the option to try another payment method.
response.gatewayCode=DECLINED or ACQUIRER_SYSTEM_ERROR
result=FAILURE		 The payment was declined. Offer the payer the option to try another payment method.
In the case of an ACQUIRER_SYSTEM_ERROR you may want to inquire with the acquirer the reason for payment failure, or you can try RETRIEVE_TRANSACTION again.
response.gatewayCode=TIMED_OUT
result=FAILURE		 Treat this as a declined payment. The Mastercard Payment Gateway will make an attempt to ensure the transaction is not successful or will revert the transaction.

Refunds

You can refund Alipay payments in part or in full. You must be configured for refunds on the Mastercard Payment Gateway and on your merchant account at your browser payments service provider.

Testing Your Integration

The Mastercard Payment Gateway provides a browser payments emulator that allows you to test your Alipay integration.

Copyright © 2023 Mastercard