You can add Alipay+ to your existing integration. The following instructions show only what you must add to your integration specifically for Alipay+.
If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.
Requirements
| Requirement | Description | |
|---|---|---|
| Integration type | Make sure that you have an existing API-only integration. | |
| Redirect handling | Make sure that your existing integration is set up to handle the redirect. action.type: redirect. |
|
| Setup steps | Before you begin, add Alipay+ in your Customer Area. |
How it works
- The shopper selects Alipay+ as payment method.
- The shopper then selects their preferred wallet that is included with Alipay+.
- The shopper enters their details in the payment form that you build, if applicable.
- When you make the payment request, you include additional information about the items that the shopper intends to purchase, if applicable.
- Your existing integration setup will handle the redirect.
Build your payment form
Include Alipay+ in the list of available payment methods. You do not need to collect any additional information from the shopper in your payment form.
You can download the logo for Alipay+ to use in your form.
Get Alipay+ as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that Alipay+ is included in the response.
| Parameter | Values |
|---|---|
| countryCode | AT, AU, BE, CA, CH, CN, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HK, HU, IE, IS, IT, JP, LI, LT, LU, LV, MT, MY, NL, NO, NZ, PL, PT, RO, SE, SG, SI, SK, US |
| amount.currency | AED, AUD, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, JPY, MYR, NOK, NZD, SEK, SGD, USD |
Add additional parameters to your /payments request
When you make a payment, add the following additional parameters:
| Parameter | Required | Description |
|---|---|---|
| channel |  |
Set to the applicable channel: Web, iOS, or Android |
| browserInfo | Information about the shopper's browser. Required when channel is Web. |
The response includes the action.type: redirect.
The shopper is redirected to the checkout page of Alipay+ where they select their wallet (for example GCash, KakaoPay, TrueMoney, DANA, AlipayHK, or one of the other available wallets).
Handle the redirect
After the shopper authenticates in their wallet they are redirected back to returnUrl.
Adyen collects the redirect result value from returnUrl, for example:
Adyen then sends the value of redirectResult in the /payments/details request:
paymentData- contains the value from the original /payments response. (When using Drop-in or the sessions flow it is handled automatically.)
It is important to note that the value for paymentMethod.type is now alipay_plus_gcash, which reflects the specific wallet the shopper used (in this example, GCash).
The original payment request used alipay_plus (the generic aggregator type). The resolved paymentMethod.type is only known after the shopper authenticates in their selected wallet app.
Webhook notification
Adyen sends an AUTHORISATION notification after the payment is processed. The paymentMethod field in the notification reflects the actual wallet used, not the generic alipay_plus.
The paymentMethod value for each wallet
Alipay+ is a super-app aggregator that supports multiple wallets.
For that reason, the paymentMethod value in the notification (and in the /payments/details response) is based on the shopper's wallet selection.
| Wallet selected by shopper | Market | paymentMethod value |
|---|---|---|
| Alipay | China | alipay_plus_alipay_cn |
| AlipayHK | Hong Kong | alipay_plus_alipay_hk |
| DANA | Indonesia | alipay_plus_dana |
| GCash | Philippines | alipay_plus_gcash |
| Kakao Pay | South Korea | alipay_plus_kakaopay |
| KPlus | Thailand | alipay_plus_kplus |
| Naver Pay | South Korea | alipay_plus_naverpay |
| Rabbit LINE Pay | Thailand | alipay_plus_rabbitlinepay |
| Touch 'n Go eWallet | Malaysia | alipay_plus_touchngo |
| Toss | South Korea | alipay_plus_tosspay |
| TrueMoney | Thailand | alipay_plus_truemoney |
Initial /payments requests always use alipay_plus (the generic type). The resolved wallet-specific type only appears in the notification and in the /payments/details response, after the shopper completed authentication in their selected wallet app.
Key implementation notes
Make sure that your implementation adheres to the following:
- Initiate a payment with alipay_plus. Always send
paymentMethod.type: alipay_plus in /payments. Do not attempt to pre-select a specific wallet via thepaymentMethod.typeparameter. - Monitor notifications by wallet type. Use
paymentMethodin the webhook to identify revenue per wallet. This is useful for reporting and reconciliation. - Alipay+ uses the redirect flow. Your frontend must call /payments/details and include the
redirectResultafter the shopper returns. - Tokenization (
storePaymentMethod: true) is not currently supported for Alipay+. Requests with this parameter set to true will fail validation. - Always send
browserInfowhenchannelis set to Web.
How to use channel and browserInfo
Adyen uses channel and browserInfo.userAgent to determine the shopper's platform context, which controls which wallet entry points are available during the redirect.
The shopper contexts are:
| Context | Typical scenario |
|---|---|
| Desktop browser | channel: Web with a desktop user agent |
| Mobile browser | channel: Web with a mobile user agent |
| In-app (webview) | channel: iOS or channel: Android |
Alipay+ uses the redirect flow. When channel is set to iOS or Android, Adyen redirects the shopper to a mobile-optimized hosted page that attempts to deep-link or auto-switch into the wallet app, if supported. There is no native SDK integration.
If you send the incorrect channel value - for example, you send Web for an in-app webview - it can result in the shopper being offered an incompatible redirect experience.
For browserInfo, use values collected from the shopper's browser at the time of checkout.
For native iOS and Android apps:
channel- set to iOS or Android, not WebbrowserInfo- not required
Test and go live
You can test your Alipay+ integration in two ways: with the Adyen Payment Simulator, or directly with Alipay+.
Test with Adyen
Use the Adyen Payment Simulator to verify that your Alipay+ integration works correctly with Adyen. You can test during development, before you go live, and after launch. The simulator does not recreate the shopper's journey through the Alipay+ app or website.
This testing option is available by default when you add Alipay+ in your test Customer Area. The payment method type is alipay_plus.
To test a redirect payment:
- Start a payment as usual in your integration. The shopper is redirected to an Adyen-hosted simulator page.
- Select the payment outcome that you want to test.
- Wait for the simulator to return the shopper to your website, then complete the payment as usual. For an Advanced flow, make a
/payments/detailsrequest. - Confirm that your integration handles the outcome that you selected, and that the payment appears in your Customer Area > Payments > Payment list.
Test directly with an Alipay+ wallet
You can also test directly with an Alipay+ wallet:
- Get an Alipay+ wallet app and set it up with a credit or debit card.
- Make a live penny test, which is a payment for a minimal amount.
View the details of your direct Alipay+ payments in your live Customer Area > Payments > Payment list.
Before you can accept live Alipay+ payments, you need to submit a request for Alipay in your live Customer Area.