> ## 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 Checkout.com

> Set up Alipay and AlipayHK payments through Checkout.com in Payrails, and see the order lines AlipayHK requires.

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

<picture noZoom>
  ![Checkout.com logo](https://assets.payrails.io/img/logos/checkout/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 Checkout.com as the payment service provider (PSP). The customer selects Alipay, confirms the payment in Alipay, and returns to your site.

Checkout.com 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 Checkout.com:

1. Set up a Checkout.com integration in your workspace. Follow the [Checkout.com integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/checkout-com.md) if you don't have one yet.
2. Ask Checkout.com to enable Alipay+ on your Checkout.com processing channel.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Checkout.com integration, select **AlipayCN**, **AlipayHK**, 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 Checkout.com

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.lines` | Required | Needed for `alipayHk`. At least one line item. Each line needs `id`, `name`, `unitPrice` and a `quantity` of one or more. Sent to Checkout.com as the order items. |
| `meta.order.lines` | Optional | Used for `alipayCn`. Sent to Checkout.com as the order items when present. |
| `meta.order.description` | Optional | Sent to Checkout.com as the payment description. |
| `meta.clientContext.clientType` | Optional | `app` or `wap` sets the Alipay terminal type. Any other value, or no value, sends `web`. |
| `meta.clientContext.osType` | Optional | `ios` or `android`. Sent to Checkout.com as the customer's operating system. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent to Checkout.com as the customer name. |
| `meta.customer.email` | Optional | Sent to Checkout.com as the customer email. |
| `meta.customer.country.code` | Optional | Sent to Checkout.com as the customer country. |

## 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.

This AlipayHK request sends the order lines that `alipayHk` requires:

```json Authorize request (AlipayHK) theme={null}
{
  "amount": {
    "value": "250.00",
    "currency": "HKD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "alipayHk",
      "amount": {
        "value": "250.00",
        "currency": "HKD"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Mei Ling",
      "lastName": "Chan",
      "email": "meiling.chan@example.com"
    },
    "order": {
      "description": "Order 1234",
      "lines": [
        {
          "id": "item-1",
          "name": "Travel adapter",
          "quantity": 1,
          "unitPrice": {
            "value": "250.00",
            "currency": "HKD"
          }
        }
      ]
    },
    "clientContext": {
      "clientType": "web"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

For customers in mainland China, send `alipayCn` with an amount in CNY:

```json Authorize request (Alipay China) theme={null}
{
  "amount": {
    "value": "200.00",
    "currency": "CNY"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "alipayCn",
      "amount": {
        "value": "200.00",
        "currency": "CNY"
      }
    }
  ],
  "meta": {
    "order": {
      "description": "Order 1235"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

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 Checkout.com handles Alipay

* Payrails creates a payment setup at Checkout.com and confirms it for the Alipay method you selected. The confirmation returns the redirect to Alipay.
* Payrails sends only order lines of type `lineItem`, or lines with no type. It skips tax, discount and shipping lines, and lines with no unit price or a zero quantity.
* If Checkout.com reports that the Alipay method isn't ready on your processing channel, the payment fails before Payrails redirects the customer.


## Related topics

- [Alipay](https://docs.payrails.com/docs/integrations/payment-methods/alipay.md)
- [DANA via Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/dana/checkout-com.md)
- [GCash via Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/gcash/checkout-com.md)


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