> ## 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 via Worldpay

> Set up Alipay and AlipayHK payments through Worldpay in Payrails, and see the billing fields Worldpay requires.

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

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

Accept [Alipay](https://docs.payrails.com/docs/integrations/payment-methods/alipay) payments from customers in mainland China and Hong Kong with Worldpay as the payment service provider (PSP). The customer selects Alipay, confirms the payment in Alipay, and returns to your site.

Worldpay processes two Alipay payment method codes:

* `alipayCn` for Alipay customers in mainland China, in CNY.
* `alipayHk` for AlipayHK customers in Hong Kong, in HKD.

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

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

## Before you begin

Complete these steps before you send your first Alipay payment through Worldpay:

1. Set up a Worldpay integration in your workspace. Follow the [Worldpay integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/worldpay.md) if you don't have one yet.
2. Ask Worldpay to enable Alipay CN, Alipay HK, or both on your Worldpay entity.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Worldpay integration, select **Alipay CN**, **Alipay HK**, or both under **Payment methods**, and save.
4. Add each Alipay code as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow.

## Request fields for Worldpay

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to the PSP when you include them.

| Field | Status | Description |
| - | - | - |
| `meta.order.softDescriptor` | Required | Sent as the payment narrative, shown on the customer's statement. |
| `meta.order.billingAddress.email` | Required | Sent to Worldpay as the customer's email. |
| `meta.order.billingAddress.name`, `meta.order.billingAddress.lastName` | Required | Sent to Worldpay as the customer's first and last name. |
| `meta.order.billingAddress.country.code` | Required | Needed for `alipayHk`. Must be `HK`. Sent to Worldpay as the payment country. Payrails doesn't send a country for `alipayCn`. |
| `meta.order.reference` | Optional | Sent to Worldpay as the order reference. |

## Authorize an Alipay payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `alipayHk` or `alipayCn` as the `paymentMethodCode`. The response includes the redirect to Alipay.

```json Authorize request (AlipayHK) theme={null}
{
  "amount": {
    "value": "250.00",
    "currency": "HKD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "alipayHk",
      "amount": {
        "value": "250.00",
        "currency": "HKD"
      }
    }
  ],
  "meta": {
    "order": {
      "reference": "order-1234",
      "softDescriptor": "Example Store",
      "billingAddress": {
        "name": "Mei Ling",
        "lastName": "Chan",
        "email": "meiling.chan@example.com",
        "country": {
          "code": "HK"
        }
      }
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

For customers in mainland China, send `alipayCn` with an amount in CNY and leave out the billing country.

After the customer confirms the payment, Alipay returns them to your `success` or `error` URL. Confirm the result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you fulfill the order.

## How Worldpay handles Alipay

* Payrails sets the Alipay page language to Chinese (`zh`) for `alipayCn`.
* Payrails doesn't check the currency or country before it sends the request. Worldpay rejects a request with a currency or country that doesn't match the Alipay method.


## Related topics

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


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