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

# WeChat Pay via Checkout.com

> Set up WeChat Pay payments through Checkout.com in Payrails, and see the order line items Checkout.com requires.

<picture noZoom>
  ![WeChat Pay logo](https://assets.payrails.io/img/logos/wechatpay/logo.svg)
</picture>

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

Accept [WeChat Pay](https://docs.payrails.com/docs/integrations/payment-methods/wechat-pay) payments with Checkout.com as the payment service provider (PSP). The customer selects WeChat Pay, scans a QR code with the WeChat app and confirms the payment.

## 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 WeChat Pay 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 support to enable WeChat Pay on the processing channel of your Checkout.com account.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Checkout.com integration, select **WeChat Pay** under **Payment methods**, and save.
4. Add WeChat Pay 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 | At least one line item. Payrails sends the line items to Checkout.com as the order items. |
| `meta.order.lines[].name` | Required | The item name. |
| `meta.order.lines[].id` | Required | Sent as the item reference. Payrails shortens it to 32 characters. |
| `meta.order.lines[].unitPrice` | Required | The price of one unit. |
| `meta.order.lines[].quantity` | Required | Must be one or more. |
| `meta.order.description` | Optional | Sent to Checkout.com as the payment description. |
| `meta.clientContext.clientType` | Optional | `web`, `app` or `wap`. Sent to Checkout.com as the terminal type. Payrails sends `web` when it's missing. |
| `meta.clientContext.osType` | Optional | `ios` or `android`. Sent to Checkout.com as the operating system. |
| `meta.customer.email` | Optional | Sent to Checkout.com as the customer email. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent to Checkout.com as the customer name. |
| `meta.customer.country.code` | Optional | Sent to Checkout.com as the customer country. |

## Authorize a WeChat Pay payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `weChatPay` as the `paymentMethodCode`. The response includes a redirect to a Payrails page that shows the WeChat Pay QR code.

```json Authorize request theme={null}
{
  "amount": {
    "value": "50.00",
    "currency": "HKD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "weChatPay",
      "amount": {
        "value": "50.00",
        "currency": "HKD"
      }
    }
  ],
  "meta": {
    "clientContext": {
      "clientType": "web"
    },
    "order": {
      "description": "Order 1234",
      "lines": [
        {
          "id": "item-1",
          "name": "Tea set",
          "quantity": 1,
          "unitPrice": {
            "value": "50.00",
            "currency": "HKD"
          }
        }
      ]
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

After the customer confirms the payment in WeChat, they return 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 WeChat Pay

* Checkout.com returns a WeChat link, not a page a browser can open. Payrails turns it into a Payrails-hosted page that shows the link as a QR code, and returns that page as the redirect.
* Payrails sends only line items to Checkout.com. Tax, discount and shipping lines in `meta.order.lines` are left out.
* Refunds use the standard Checkout.com refund flow.


## Related topics

- [WeChat Pay](https://docs.payrails.com/docs/integrations/payment-methods/wechat-pay.md)
- [STC Pay via Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/stc-pay/checkout-com.md)
- [WeChat Pay via Nuvei](https://docs.payrails.com/docs/integrations/payment-methods/wechat-pay/nuvei.md)


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