Payment-method icon

UnionPay SecurePay

Use SecurePay authentication for China UnionPay.

Read more

  Learn about pricing and settlement services for UnionPay on adyen.com

China UnionPay International (UPI) is the only interbank network in Mainland China, East and Southeast Asia, and the biggest card scheme globally by number of cards.

This page explains how to accept UnionPay payments with SecurePay authentication. Provided by more than 70 Chinese issuing banks, SecurePay is a redirect integration, where the shopper is redirected to UnionPay's secure webpage to provide their credit or debit card payment details and authenticate themselves using UnionPay's security control system.

Payment type Payment flow Countries Currencies Recurring Refunds Partial refunds Chargebacks
Credit and debit cards Redirect International Multiple -x- -white_check_mark- -white_check_mark- -white_check_mark-

Before you begin

Before starting your UnionPay integration:

  1. Make sure that you have set up your back end implementation.
  2. Add UnionPay in your Customer Area.

Build your payment form for UnionPay

Include UnionPay 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 UnionPay 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: unionpay for Web, or for iOS and Android.

Make a payment

From your server, make a /payments request, specifying:

  • paymentMethod.type: unionpay

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.

    When using the HTTP GET method:
    For security reasons, when displaying 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.

  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 from the /payments response to present the payment result to your shopper. You will also receive the outcome of the payment asynchronously in a webhook.

For UnionPay SecurePay payments, you can receive the following resultCode values:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. For more information, check the refusalReason field. Inform the shopper that there was an error processing their payment.
Refused The payment was refused. For more information, check the refusalReason field. 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. The webhooks you can receive for UnionPay are:

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.
OFFER_CLOSED true The shopper did not complete the payment. Cancel the order and inf

Test and go live

When you test UnionPay payments, you are redirected to a page where you can select different statuses to simulate with. We recommend testing each status code.

Check the status of UnionPay test payments in your Customer Area > Transactions > Payments.

Before you can accept live UnionPay payments, you need to submit a request for UnionPay in your live Customer Area.

See also