Skip to content
APIs/APMs/
WeChat Pay

Last updated: 10 February 2026 | Change log

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 to ensure a resilient integration.

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 typeRecurringReversalsPartial reversalsDisputesAuth and settlement (sale)
Digital wallet❌✅✅❌✅
  • Maximum transaction value: 50.000 CNY
  • Maximum transaction per consumer wallet per day: 100.000 CNY

Acceptance currencies

CurrencyCurrency codes
Australian DollarAUD
Canadian DollarCAD
Chinese YuanCNY
EuroEUR
Hong Kong DollarHKD
Japanese YenJPY
New Zeland DollarNZD
Pound SterlingGBP
US DollarUSD
Singapore DollarSGD

Get started

Use our API reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example requests

application/json
{
  "transactionReference": "Memory265-13/08/1876",
  "orderReference": "apm-order-12345",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "wechatpay",
    "expiryIn": 10,
    "value": {
      "amount": 250,
      "currency": "CNY"
    },
    "narrative": {
      "line1": "MindPalace"
    },
    "paymentInstrument": {
      "type": "direct"
    }
  }
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

For Bizum transaction please follow this extra regex [a-zA-Z0-9]{4,12}

orderReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$

A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

  • the total amount for a single order is split across multiple payments
  • you use a single reference for each payment in a recurring agreement or split shipment scenario
merchantobject(MerchantV2)required
merchant.​entitystring[ 3 .. 32 ] characters^([a-zA-Z0-9\- ]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.​methodstringrequired

Type of payment method

Value"ach"
Discriminator
instruction.​valueobject(Value)required

The value of the payment.

instruction.​value.​amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12
instruction.​value.​currencystringrequired
Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"
instruction.​narrativeobject(NarrativeBase)required
instruction.​narrative.​line1string[ 1 .. 24 ] characters^[a-zA-Z0-9-., ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"
instruction.​paymentInstrumentobject(AchEftPaymentInstrumentV2)required
instruction.​paymentInstrument.​typestringrequired

The type of instrument.

Value"direct"
instruction.​paymentInstrument.​accountTypestringrequired

Account type.

Enum"checking""savings""corporate""corporateSavings"
Example: "checking"
instruction.​paymentInstrument.​accountNumberstring[ 1 .. 17 ] characters^[0-9]*$required

Account number of direct debit account.

Example: "123456789"
instruction.​paymentInstrument.​routingNumberstring= 9 characters^[0-9]*$required

Routing number of direct debit account.

Example: "123456789"
instruction.​paymentInstrument.​checkNumberstring[ 1 .. 15 ] characters^[0-9]*$

Check number of the direct debit account.

Example: "123456789"
instruction.​paymentInstrument.​companyNamestring[ 1 .. 40 ] characters^[0-9]*$

Company name if a corporate account.

Example: "123456789"
instruction.​paymentInstrument.​billingAddressobject(AchEftBillingAddress)required
instruction.​paymentInstrument.​billingAddress.​address1string[ 1 .. 80 ] characters
instruction.​paymentInstrument.​billingAddress.​address2string[ 1 .. 80 ] characters
instruction.​paymentInstrument.​billingAddress.​address3string[ 1 .. 80 ] characters
instruction.​paymentInstrument.​billingAddress.​citystring[ 1 .. 50 ] characters

City.

instruction.​paymentInstrument.​billingAddress.​countryCodestring
Enum"AD""AE""AF""AG""AI""AL""AM""AN""AO""AQ"
instruction.​paymentInstrument.​billingAddress.​postalCodestring[ 1 .. 15 ] characters

Postal code.

instruction.​paymentInstrument.​billingAddress.​statestring[ 1 .. 30 ] characters

State code of the billing address in ISO 3166-2 format.

Example: "US-OH"
instruction.​customerobject(CustomerDetailsAch)required
instruction.​customer.​firstNamestring[ 1 .. 22 ] charactersrequired

Your customer's first name.

instruction.​customer.​lastNamestring[ 1 .. 22 ] charactersrequired

Your customer's last name.

instruction.​customer.​customerIdstring<= 15 characters^[a-zA-Z0-9]*$

Your unique reference for the customer so that the 'pay faster next time' function can be used during checkout. This allows the shoppers chosen bank to be stored for their next payment.

Example: "44528abcd"
instruction.​customer.​emailstring

The customer's e-mail address.

Example: "customer@worldpay.com"

Response

Example response

{
  "paymentId": "HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.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"
}

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.

Schema

paymentIdstring

The identifier of the payment resource.

lastEventstring
Enum"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"
_linksobject(Links)

Links to resources related to the request.

_actionsobject(Actions)
redirectstring

The URL to redirect your customer to.

paymentInstrumentobject(PaymentInstrumentResponse)
commandIdstring

An action ID generated by us identifying a single merchant interaction

Example: "cmdYNdIHBPJwbkjLiykzTx0"

Errors

Check out our API reference for more responses or error codes.

Next steps

Manage your WeChat Pay payment