Accept WeChat Pay in-app payments using our APIs, and build your integration using WeChat Pay mobile SDKs.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have built an API-only integration. |
| Setup steps | Before you begin, add in your test Customer Area. |
Preparation
- Create a developer account on the WeChat Open Platform.
- Register your mobile app with WeChat.
- Integrate WeChat's mobile SDKs for iOS or Android.
Build your payment form for WeChat Pay
Check if WeChat is available in the shopper's device, and then show WeChat Pay as an available payment method in your mobile app.
We provide logos for WeChat Pay which you can use on your payment form. For more information, refer to Downloading logos.
You can also submit a /paymentMethods request specifying:
- countryCode: Any supported country/region. For example, CN.
- amount.currency: Any supported currency. For example, CNY.
In the response, you receive paymentMethod.type: wechatpaySDK.
Make a payment
When the shopper selects to pay with WeChat Pay:
-
From your server, make a /payments request providing:
paymentMethod.type: wechatpaySDK
The /payments response contains:
action: Object containing information that you will need when invoking the WeChat Pay SDK.
-
Pass the values in the
sdkDataobject to the WeChat Pay SDK. The WeChat Pay SDK launches the WeChat app, where the shopper can proceed to complete the payment. -
Get the result from the WeChat Pay SDK.
Check the payment result
When the shopper completes the payment on the WeChat app, make a /payments/details to check the payment result.
In your /payments/details request, provide the following:
resultCode: Value you received from the WeChat Pay SDK.-
paymentData: Encoded payment data. If you receivedresultCode: AuthenticationNotRequired in the /payments response, use thethreeDSPaymentDatafrom the same response. If you receivedresultCode: AuthenticationFinished in the /payments response, use theaction.paymentDatafrom the same response.
Present the payment result
Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode values you can receive for WeChat Pay are:
| resultCode | Description | Action to take |
|---|---|---|
| Authorised | The payment was successful. | Inform the shopper that the payment has been successful. You will receive the funds in 2-3 days. |
| Error | 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. |
| Pending or Received |
The payment order was successfully received. | Inform the shopper that you have 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. |
| Refused | 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.