Integrated into the all-in-one superapp WeChat, WeChat Pay is one of the most popular payment methods for Chinese consumers.

Payment Method Properties


Category	Digital Wallet
Markets	`CN`
One-time payments	Yes
Recurring payments	No
Processing currencies	CH, GB merchants: `CHF` `CNY` `EUR` `GBP` `USD` DE, FR, HU, IE, LU, NL, NO merchants: `CNY` `EUR` IT merchants: `CNY` `EUR` `GBP` `USD`
Consumer currencies	`CNY`
Settlement currencies	CH, GB merchants: `CHF` `EUR` `GBP` `USD` DE, FR, HU, IE, LU, NL, NO merchants: `EUR` IT merchants: `EUR` `GBP` `USD`
Minimum payment amount	0.01 CNY (or equivalent)
Maximum payment amount	50,000.00 CNY (or equivalent) per transaction per day from wallet. Linked cards vary by issuer
Refund	Full - Partial - Multiple
Captures	No
Refund validity	365 days
Chargeback	No
Sandbox availability	PPRO provided

Make a WeChat Pay Online payment

To make a WeChat Pay Online payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Field	Description
`paymentMethod`	`WECHATPAY`
`amount.value`	The amount to be paid in the smallest units of the currency used.
`amount.currency`	`EUR`
`consumer.name`	Full name of the consumer
`consumer.country`	The country of residence of the consumer.
`consumer.email`	The consumer’s email address
`authenticationSettings: REDIRECT settings.returnUrl`	Add the url where the consumer should be redirected to after they complete the payment.

Request:

POST /v1/payment-charges

{
    "paymentMethod": "WECHATPAY",
    "amount": {
        "value": 100,
        "currency": "EUR"
    },
    "consumer": {
        "name": "John Smith",
        "country": "DE",
        "email": "[email protected]"
    },
    "authenticationSettings": [
        {
            "type": "REDIRECT",
            "settings": {
                "returnUrl": "https://www.webshop.com/order-results-page"
            }
        }
    ]
}

Response:

You'll receive one of our standard payment charge responses (see potential responses in the API Reference)

{
   "id": "charge_0Z6Rb3aXZLowbpdCRgbue",
   "paymentMethod": "WECHATPAY",
   "paymentMedium": "ECOMMERCE",
   "scheduleType": "UNSCHEDULED",
   "instrumentId": "instr_KJgFGueIskdsylo3kbnYv",
   "currency": "EUR",
   "country": "CN",
   "paymentDescriptor": "Payment Descriptor",
   "status": "AUTHENTICATION_PENDING",
   "consumer": {
       "name": "John Smith",
       "email": "[email protected]",
       "country": "CN"
   },
   "order": {
       "orderItems": [
           {
               "name": "Product Name 1",
               "quantity": 1,
               "amount": 100
           }
       ],
       "industryData": []
   },
   "authenticationMethods": [
       {
           "details": {
               "requestUrl":"https://redirection-target.com",
               "requestMethod": "GET"
           },
           "type": "REDIRECT"
       }
   ],
   "authorizations": [
       {
           "id": "authz_NaYyFjUJpYPHKVwnte9lI",
           "amount": 100,
           "status": "AUTHENTICATION_PENDING",
           "merchantPaymentChargeReference": "ic9dJqzDYLfC6wi",
           "createdAt": "2025-02-28T10:26:03.358Z",
           "updatedAt": "2025-02-28T10:26:03.358Z"
       }
   ],
   "captures": [],
   "refunds": [],
   "voids": [],
   "createdAt": "2025-02-28T10:26:02.890Z",
   "updatedAt": "2025-02-28T10:26:03.358Z"
}

Pick the desired authentication method

REDIRECT

Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.

Handling the payment result

REDIRECT

After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

Payment instrument

An instrument of type PASSTHROUGH_WALLET will be created for Pay By Bank payments.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
  "id": "instr_Asu0ig2PXXZSiNrhY44A5",
  "type": "PASSTHROUGH_WALLET"
}

Sandbox testing

WeChat Pay Online uses PPRO's mock authenticator in sandbox. Learn more.