**Last updated**: 17 November 2025 | [**Change log**](/products/apms/changelog/)

# WeChat Pay

WeChat Pay, officially referred to as Weixin Pay in China, is a mobile payment and digital wallet service.

Note
Make yourself familiar with our [API principles](/products/reference/api-principles) to ensure a resilient integration.

details
summary
Product overview
## Why use WeChat Pay?

WeChat Pay is a digital wallet allowing your customers to make online or mobile wallet payments. It is considered a vital payment method if you are operating in China.

### Feature summary

| Payment type | Recurring | Reversals | Partial reversals | Disputes | Auth and settlement (sale) |
|  --- | --- | --- | --- | --- | --- |
| Digital wallet | ❌ | ✅ | ✅ | ❌ | ✅ |


- Maximum transaction value: 50.000 CNY
- Maximum transaction per consumer wallet per day: 100.000 CNY


#### Acceptance currencies

| Currency | Currency codes |
|  --- | --- |
| Australian Dollar | AUD |
| Canadian Dollar | CAD |
| Chinese Yuan | CNY |
| Euro | EUR |
| Hong Kong Dollar | HKD |
| Japanese Yen | JPY |
| New Zeland Dollar | NZD |
| Pound Sterling | GBP |
| US Dollar | USD |
| Singapore Dollar | SGD |


## Get started

Get started using our [API reference](/products/apms/openapi) and set your headers.

## Request

`POST` `https://try.access.worldpay-bsh.securedataplatform.com/apmPayments`

### Example requests

### Parameters

## Response

#### Successful request response

* an HTTP code 201
* a `paymentId` which is unique to the payment - we recommend storing the "id", as you can use it to manage the payment later
* a QR Code in Base64 format to display to your customer to complete the payment
* a link to query the payment status
* an object which will give flow information such as `method` (e.g. `wechatpay`) and type (`direct`)
* a `commandId` generated by us identifying a single merchant interaction (e.g. `cmdYNdIHBPJwbkjLiykzTx0`)


#### Testing

All requests return the same encoded QR code, allowing you to test the synchronous response and the embedding of the QR code image within your checkout page.

Following a short delay test payments will automatically update to authorize once you receive the successful payment response.

### Example response

Successful
{
  "paymentId": "HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c"
    }
  },
  "_actions": {},
  "redirect": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQAAAAB0CZXLAAABdklEQVR4Xu2VS27DMAxE6ZWP4ZvG1E19DK3EzpBKgrhAu+2gGjiCTD0vJvzI4hfZPXDXAkoLKC2gtIDSvwLcoCN6PnGdne+bGtDw68fYAw+AjVgGtYBuCDYYpEeadTtEAXh02My9OoDyO0WBYMmlwWwZ7CsoBTjDR+uvJzE1oNSycWzH+pYQgALz9NXS8qPGshqAluHRDo+BZIEfn40jAXi2fI2vwTnGqtvUgLFfeB1MGbN2svamtAAzWjvTZjJ6QDB+PTJlgyTWj2RJAKPu9NzgtGUR6gGZHTg95yi+6lQLcDRO5wRuT8svRggIvrLk4NFyCETmTgtonUGn2bm52ZQABg1OLJPFtakBjcwxR7Gl9s//QQEoOXKECTaHGFctwGlsZqoFC4+rGkBHGUS/WBp0kmpAt40Ag3AK11t9JQgE70ScHjOiCdAdzD7J7zb/OhBZcmR4m9As7xQxwA1CyXGIOYfw/VqUAH7QAkoLKC2gtIDSAkpfsu6k9bsX4o0AAAAASUVORK5CYII=",
  "paymentInstrument": {
    "method": "wechatpay",
    "type": "direct"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}
Error response
{
  "errorName": "bodyDoesNotMatchSchema",
  "message": "The json body provided does not match the expected schema",
  "validationErrors": [
    {
      "errorName": "fieldHasInvalidValue",
      "message": "Field is mandatory",
      "jsonPath": "$.instruction.value.amount"
    }
  ]
}
#### Errors

Check out our API reference for the full [error code schema](/products/apms/openapi/other/payment#other/payment/response&c=400).

**Next steps**

[Manage your WeChat Pay payment](/products/apms/manage/)