> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Alipay

> Accept Alipay wallet payments, see which payment method code each PSP expects, and check the PSPs that process Alipay through Payrails.

<picture noZoom>
  ![Alipay logo](https://assets.payrails.io/img/logos/alipay/logo-full-bleed.svg)
</picture>

Alipay is a digital wallet used by customers in mainland China and, through AlipayHK, in Hong Kong. Customers log in to Alipay and confirm each payment in the Alipay app or on the Alipay website.

Payrails processes Alipay through four payment service providers (PSPs). The flow is the same with each one, but the payment method code, the required request fields, and the supported workflows differ. Pick a PSP below for its setup steps and request examples.

## How an Alipay payment works

Alipay is a redirect payment method:

1. The customer selects Alipay at checkout.
2. Payrails returns a redirect URL from the PSP, and the customer goes to Alipay.
3. The customer logs in and confirms the payment in the Alipay app or on the Alipay website.
4. Alipay sends the customer back to your `returnInfo` URL.
5. Payrails receives the final result from the PSP and updates the payment.

Payrails captures Alipay payments immediately, so a successful payment is final. To return funds, [refund the payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md).

### Alipay payment method codes

Each PSP accepts its own Alipay payment method code. Send the code that matches the PSP that processes the payment:

| `paymentMethodCode` | Wallet | PSPs |
| - | - | - |
| `alipay` | Alipay | Nuvei, Stripe |
| `alipayCn` | Alipay for customers in mainland China | Checkout.com, Worldpay |
| `alipayHk` | AlipayHK for customers in Hong Kong | Checkout.com, Worldpay |

To offer Alipay through Checkout.com or Worldpay to customers in both regions, enable `alipayCn` and `alipayHk` as two separate payment methods on the integration.

This page covers online payments. In-person Alipay payments on Adyen payment terminals use a separate `alipayQRCode` code and aren't covered here.

## Supported currencies and countries

The presentment currency depends on the PSP and the payment method code:

* **Checkout.com and Worldpay:** `CNY` (Chinese yuan) for `alipayCn`, and `HKD` (Hong Kong dollar) for `alipayHk`.
* **Stripe:** `AUD`, `CAD`, `CNY`, `EUR`, `GBP`, `HKD`, `JPY`, `MYR`, `NZD`, `SGD`, and `USD`.
* **Nuvei:** the currencies enabled for Alipay on your Nuvei account.

Alipay is available to customers based in:

<table>
  <thead>
    <tr><th>Regions</th><th>Countries</th></tr>
  </thead>

  <tbody>
    <tr><td>**Asia Pacific**</td><td>🇦🇺 Australia🇨🇳 China🇭🇰 Hong Kong🇯🇵 Japan🇲🇾 Malaysia🇳🇿 New Zealand🇸🇬 Singapore</td></tr>
    <tr><td>**Europe**</td><td>🇦🇹 Austria🇧🇪 Belgium🇧🇬 Bulgaria🇨🇾 Cyprus🇨🇿 Czech Republic🇩🇰 Denmark🇪🇪 Estonia🇫🇮 Finland🇫🇷 France🇩🇪 Germany🇬🇷 Greece🇭🇺 Hungary🇮🇪 Ireland🇮🇹 Italy🇱🇻 Latvia🇱🇹 Lithuania🇱🇺 Luxembourg🇲🇹 Malta🇳🇱 Netherlands🇵🇱 Poland🇵🇹 Portugal🇷🇴 Romania🇸🇰 Slovakia🇸🇮 Slovenia🇪🇸 Spain🇸🇪 Sweden🇬🇧 United Kingdom</td></tr>
    <tr><td>**North America**</td><td>🇨🇦 Canada🇺🇸 United States</td></tr>
  </tbody>
</table>

## Integrate Alipay

Choose the PSP that processes Alipay for you. Each guide covers the PSP-side setup, the Payrails configuration and the request fields that PSP requires.

> [card]
>
> Checkout.com logo
>
> Checkout.comAlipay via Checkout.com
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/alipay/checkout-com.md)

> [card]
>
> Nuvei logo
>
> NuveiAlipay via Nuvei
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/alipay/nuvei.md)

> [card]
>
> Stripe logo
>
> StripeAlipay via Stripe
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/alipay/stripe.md)

> [card]
>
> Worldpay logo
>
> WorldpayAlipay via Worldpay
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/alipay/worldpay.md)

## Check PSPs

<table>
  <thead>
    <tr><th>Workflow</th><th>[Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/alipay/checkout-com.md)</th><th>[Nuvei](https://docs.payrails.com/docs/integrations/payment-methods/alipay/nuvei.md)</th><th>[Stripe](https://docs.payrails.com/docs/integrations/payment-methods/alipay/stripe.md)</th><th>[Worldpay](https://docs.payrails.com/docs/integrations/payment-methods/alipay/worldpay.md)</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
  </tbody>
</table>

Each Alipay payment is a new customer-initiated payment.

## Ways to integrate Alipay

* **Payrails SDK:** the [Web SDK](https://docs.payrails.com/docs/sdks/web.md) shows Alipay when your workflow returns it as a payment option, and redirects the customer to Alipay. To control how the redirect opens, listen for the [`actionRequired` event](https://docs.payrails.com/docs/sdks/web/guides/action-required-event).
* **Payrails API:** call [lookup payment options](https://docs.payrails.com/docs/orchestration/payment-acceptance/lookup-payment-options.md), then authorize with the `paymentMethodCode` your PSP expects. Each PSP guide lists the code and the `meta` fields that PSP requires.

In both cases, confirm the final result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status. Don't treat the customer's return to your `success` URL as proof of payment.


## Related topics

- [Alipay via Worldpay](https://docs.payrails.com/docs/integrations/payment-methods/alipay/worldpay.md)
- [Alipay via Stripe](https://docs.payrails.com/docs/integrations/payment-methods/alipay/stripe.md)
- [Alipay via Nuvei](https://docs.payrails.com/docs/integrations/payment-methods/alipay/nuvei.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.