Payment-method icon

WeChat Pay Drop-in integration

Add WeChat Pay to an existing Drop-in integration.

This page explains how to add to your existing Android Drop-in integration.

If you are using Android Drop-in v5.0.0 or later:

This payment method requires no additional configuration.

Follow the Drop-in integration guide.

WeChat Pay is supported from Android Drop-in version 3.5.0 and later. For more information, see release notes.

Our Android Drop-in renders WeChat Pay in your payment form, and triggers the app switch from your app to the WeChat app on the shopper's device.

Requirements

Requirement Description
Integration type Make sure that you have an existing Advanced flow Android Drop-in integration.
Setup steps Before you begin, add in your Customer Area.

Preparation

  1. Create a developer account on the WeChat Open Platform.
  2. Register your mobile app with WeChat.

Show WeChat Pay in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show WeChat Pay in your payment form, specify in your /paymentMethods request:

WeChat Pay is only shown in the payment form if WeChat app is available in the shopper's device.

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

  1. Pass the paymentComponentData.paymentMethod to your server.

  2. From your server, make a /payments request, specifying:

    • paymentMethod: The paymentComponentData.paymentMethod from your client app.

    The /payments response includes an action object that contains information about the app switch.

  3. Pass the action object to your client app.

Check the payment result

Drop-in uses the action object to launch the WeChat app, where the shopper completes the payment, and is then redirected back to your app.

To check the payment result, make a /payments/details request.

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.

See also