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

> Accept WeChat Pay wallet payments from customers in China, and check the PSPs that process WeChat Pay through Payrails.

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

WeChat Pay is the wallet built into the WeChat app. Customers pay by scanning a QR code with WeChat, or by confirming the payment in the WeChat app on their phone.

Payrails processes WeChat Pay through three payment service providers (PSPs). Each PSP shows the QR code in a different way, and the required request fields and the supported workflows differ. Pick a PSP below for its setup steps and request examples.

## How a WeChat Pay payment works

WeChat Pay is a QR code payment method:

1. The customer selects WeChat Pay at checkout.
2. Payrails sends the payment to the PSP, and the PSP returns a QR code for the payment.
3. The customer scans the QR code with the WeChat app and confirms the payment.
4. Payrails receives the final result from the PSP and updates the payment.

With Checkout.com and Nuvei, Payrails returns a redirect to a page that shows the QR code. With Worldpay, there's no redirect: the payment stays pending until Worldpay confirms it.

Each payment is single-use: the customer confirms every payment on its own. Payrails captures WeChat Pay 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).

## Supported currencies and countries

The presentment currencies depend on the PSP:

| PSP | Currencies |
| - | - |
| Checkout.com | HKD (Hong Kong dollar) |
| Nuvei | CNY (Chinese yuan), EUR (euro), GBP (pound sterling), USD (United States dollar) |
| Worldpay | CNY (Chinese yuan) |

WeChat Pay is available to customers based in:

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

  <tbody>
    <tr><td>**Asia Pacific**</td><td>🇨🇳 China</td></tr>
  </tbody>
</table>

## Integrate WeChat Pay

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

> [card]
>
> Checkout.com logo
>
> Checkout.comWeChat Pay via Checkout.com
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/wechat-pay/checkout-com.md)

> [card]
>
> Nuvei logo
>
> NuveiWeChat Pay via Nuvei
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/wechat-pay/nuvei.md)

> [card]
>
> Worldpay logo
>
> WorldpayWeChat Pay via Worldpay
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/wechat-pay/worldpay.md)

## Check PSPs

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

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>Payrails API</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></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></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</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></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</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></tr>
  </tbody>
</table>

## Ways to integrate WeChat Pay

* **Payrails SDK:** the [Web SDK](https://docs.payrails.com/docs/sdks/web.md) shows WeChat Pay when your workflow returns it as a payment option, and redirects the customer to the QR code page. 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 `weChatPay` as the `paymentMethodCode`. Each PSP guide lists 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

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


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