Alipay via Worldpay

Accept 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

Workflow	Supported
Payrails SDK	✔
Payrails API	✔
Delayed / Manual Capture	✖
Instant Capture	✔
Cancel / Void	✖
Refund / Reverse	✔
Save Instruments	✖
Merchant Initiated Transaction (MIT)	✖

Before you begin

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

Set up a Worldpay integration in your workspace. Follow the Worldpay integration setup guide if you don’t have one yet.
Ask Worldpay to enable Alipay CN, Alipay HK, or both on your Worldpay entity.
In the Payrails Portal, go to Settings → Integrations, open your Worldpay integration, select Alipay CN, Alipay HK, or both under Payment methods, and save.
Add each Alipay code as a payment option in your workflow.

Request fields for Worldpay

Send these fields in the authorize request, in addition to the standard authorize fields. 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 with alipayHk or alipayCn as the paymentMethodCode. The response includes the redirect to Alipay.

Authorize request (AlipayHK)

{
  "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 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.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Worldpay

Authorize an Alipay payment

How Worldpay handles Alipay

​Supported workflows

​Before you begin

​Request fields for Worldpay

​Authorize an Alipay payment

​How Worldpay handles Alipay

Supported workflows

Before you begin

Request fields for Worldpay

Authorize an Alipay payment

How Worldpay handles Alipay