Payment-method icon

WeChat Pay in-app for API only

Accept WeChat Pay payments from mobile app with your existing API-only integration.

Accept WeChat Pay in-app payments using our APIs, and build your integration using WeChat Pay mobile SDKs.

Before you begin

These instructions explain how to add WeChat Pay 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 you can accept WeChat Pay payments in-app, you'll need to:

  1. Make sure that you have set up your back end implementation for making API requests.
  2. Add WeChat Pay in your test Customer Area.
  3. Create a developer account on the WeChat Open Platform.
  4. Register your mobile app with WeChat.
  5. 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:

In the response, you receive paymentMethod.type: wechatpaySDK.

Make a payment

When the shopper selects to pay with WeChat Pay:

  1. 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.
  2. Pass the values in the sdkData object to the WeChat Pay SDK. The WeChat Pay SDK launches the WeChat app, where the shopper can proceed to complete the payment.

  3. 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.

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
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.
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:

  • Cancelling 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.

See also