Accept WeChat Pay web payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add WeChat Pay web to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your WeChat Pay web integration:
- Make sure that you have set up your back end implementation.
- Add WeChat Pay QR in your test Customer Area.
Build your payment form for WeChat Pay web
Include WeChat Pay web in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for WeChat Pay that you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: The country where the shopper is. In this case a supported country outside of China, for example NL.
- amount.currency: Any supported currency. For example, EUR. See Processing currencies for ecommerce for more information.
- channel: Specify Web, iOS, or Android.
The response contains
Make a payment
In your /payments request, specify:
In the /payments response, note the
action object. This contains the information needed to redirect the shopper.
Handle the redirect
To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
In the response note the following:
resultCode: use this to present the result to your shopper.
pspReference: our unique identifier for the transaction.
Present the payment result
resultCode that you received in the /payments/details response to present the payment result to your shopper.
resultCode values you can receive for WeChat Pay are:
|Action to take
|The payment was successful.
|Inform the shopper that the payment has been successful.
You will receive the funds in 2-3 days.
|There was an error when the payment was being processed.
|Inform the shopper that there was an error processing their payment. The response contains a
refusalReason, indicating the cause of the error.
|The payment order was successfully received.
|Inform the shopper that you've received their order, and are waiting for the payment to clear.
You will receive the final result of the payment in an AUTHORISATION webhook. If successful, you will receive the funds in 2 days.
|The payment was refused by the shopper's bank.
|Ask the shopper to try the payment again using a different payment method.
Test and go live
WeChat Pay currently has no test platform. If you have a personal WeChat account you can test your integration by either:
- Canceling the transaction when you are asked to verify the payment (recommended).
- Making live WeChat Pay payments with a low value.
You can check the status of a WeChat Pay payment in your Customer Area > Transactions > Payments.
Before you can accept live WeChat Pay payments, you need to submit a request for WeChat Pay in your live Customer Area.