WeChat Pay web for API only

Add WeChat Pay web to an existing API-only integration.

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.

Requirements

Requirement	Description
Integration type	Make sure that you have built an API-only integration.
Setup steps	Before you begin, add WeChat Pay web in your test Customer Area.

Include WeChat Pay web in the list of available payment methods. You do not 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/region where the shopper is. In this case a supported country/region 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 paymentMethod.type: wechatpayWeb.

In your /payments request, specify:

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:
- When using the HTTP GET method:
  For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.
- Redirection for mobile integrations:
  For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.
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 redirectResult returned 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.

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.

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.