APIs
/
APM
/
Alipay China

Last Updated: 19 February 2025 | Change Log

Alipay China

AlipayCN is a key payment method in China.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product Overview

AlipayCN is one of China's most widely used digital payment platforms, offering seamless transactions both in-app and on web. Similar to domestic online/in-app payments, the amount is deducted from your customer's Alipay account in real-time. Alipay converts these payments into your currency and sends the amount directly your acquirer.

AlipayCN supports a redirect flow meaning your customers are rediected from your website, or mobile application, to the AlipayCN payment page where they authorize and confirm the payment.

Why use AlipayCN?

  • popularity and high usage: AlipayCN is one of the dominant players in the Chinese market with an ever growing user base
  • attracting Chinese tourists: Chinese tourists are known to use Alipay heavily for cross-border payments, with 93% awareness in this market
  • high approval rates and low chargeback/dispute rate
  • frictionless experience for Chinese customers while benefiting from a secure and scalable payment infrastructure

Feature summary

Payment typeRecurringReversalsPartial ReversalsAuth and Settlement (Sale)Customer CountryAuthorisation timescale*
Digital wallet❌
  • Refund - yes
  • Cancel- No
  • Partial refund - yes
  • Partial cancel- No
✅China10 mins
  • Maximum Transaction Value: 300.000 CNY - if you require a higher amount please contact your Relationship Manager

Acceptance currencies

MarketCurrency
UKCNY1 AUD2, GBP2 EUR2, CAD2, SGD2, JPY2, USD2
EuropeCNY1, HKD2, AUD2, GBP2, EUR2, CAD2, SGD2, JPY2, USD2
Hong KongHKD1
SingaporeCNY1

1 Indicates that you can authorize in this currency, but you receive funds in a different currency
2 Indicates that you can authorize and receive funds in the same currency without any FX consideration (depending on your contract)

Customer journey

Desktop with QR code scanned on a mobile device

Desktop shopper journey

  1. Your customer selects AlipayCN as a payment method on your desktop site
  2. Your customer is redirected to the AlipayCN payment page which displays the AlipayCN QR code
  3. Your customer scans the QR code using the scan function within their AlipayCN mobile app
  4. Your customer is presented with the transaction details and funding options. Your customer then confirms the payment
  5. Your customer enters the payment password to authenticate the transaction
  6. Your customer receives successful payment confirmation
  7. Back on your customer's desktop browser, AlipayCN confirms that the payment is successful and returns your customer to your payment success page (defined by the successURL)

Mobile device with AlipayCN app

Mobile shopper journey

  1. Your customer selects AlipayCN as a payment method on your mobile browser site/ in-app checkout page
  2. Your customer is redirected to AlipayCN app on their mobile device to confirm the payment. If the AlipayCN app is not installed, your customer is prompted to install the app
  3. Your customer keys in the payment password to authenticate the transaction
  4. Your customer receives successful payment confirmation
  5. Your customer clicks the "Done" button and returns to the your payment success page (defined by the successURL)

Get Started

Get started using our API Reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example requests

Response
application/json
{
  "paymentId": "HZ75WBkfRwmD9YzLSZFnQ--xazN30hqhileEoUF53VKlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2K6uz6RKmSmP_m7-TgEHezOhzH5eLvBJHPh6ir8ugqJqGjb7dlrQPJ4byuGHVAMZ8",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ--xazN30hqhileEoUF53VKlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2K6uz6RKmSmP_m7-TgEHezOhzH5eLvBJHPh6ir8ugqJqGjb7dlrQPJ4byuGHVAMZ8"
    }
  },
  "_actions": {},
  "redirect": "https://mock.hpp.worldpay.com/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah",
  "paymentInstrument": {
    "method": "paypal",
    "type": "redirect"
  }
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required
merchantobject(MerchantV2)required
merchant.​entitystring[ 1 .. 32 ] characters^([a-zA-Z0-9]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.​methodstringrequired

The type of instrument.

Value"paypal"
Discriminator
instruction.​valueobject(Value)required

The value of the payment.

instruction.​value.​amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12
instruction.​value.​currencystringrequired
Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"
instruction.​narrativeobject(NarrativeBase)required
instruction.​narrative.​line1string[ 1 .. 24 ] characters^[a-zA-Z0-9\\-\\.\\,\\ ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"
instruction.​paymentInstrumentobject(PayPalInstrumentV2)required
instruction.​paymentInstrument.​typestringrequired

The type of instruction.

Value"direct"
instruction.​paymentInstrument.​billingAddressobject(PayPalBillingAddressV2)
instruction.​settlementobject(Settlement)

Indicates whether the transaction should be sent for settlement now = true, or later = false at a time of your choosing.

instruction.​resultUrlsobject(ResultUrls)
instruction.​shippingobject(Shipping)
instruction.​customerobject(Customer)

Response

Successful request response

  • an HTTP code 201
  • an id which is unique to the payment - we recommend storing the "id" as this can be used to manage the payment later
  • a url to redirect your customer to the APM provider to complete the payment
  • a link to query the payment status
  • an object which will give flow information such as method (e.g. alipaycn) and type (direct)

Example Response

{
  "paymentId": "HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c"
    }
  },
  "_actions": {},
  "redirect": "https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3413879489&paymentMethod=ALIPAY_CN",
  "paymentInstrument": {
    "method": "alipay_cn",
    "type": "direct"
  }
}

Errors

Check out our API reference for the full error code schema.

Manage your Alipay China payment