Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

WeChat Pay Official account payments

Accept payments from your WeChat Official page.

A WeChat Official page is similar to a Facebook page or Verified Twitter profile. In addition to keeping your WeChat followers up-to-date, you can also serve your mobile website within the WeChat app, and initiate WeChat Pay payments.

When shoppers proceed to pay from your WeChat Official page, they are prompted to verify the payment. If successful, they are redirected back to your mobile website and presented with the payment result.

Official account payments must be initiated from the WeChat in-app browser. They cannot be initiated from another browser, such as Chrome or Safari.

Payment type Payment flow Countries Currencies Recurring Refunds Partial refunds Chargebacks
Wallet Redirect International AUD, CAD, CNY, EUR,
GBP, HKD, JPY, NZD,
SGD, USD
-x- -white_check_mark- -white_check_mark- -x-  

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 starting your WeChat Pay Official account payments integration:

  1. Make sure that you have set up your back end implementation.
  2. Add WeChat Pay in your test Customer Area.
  3. Register for a WeChat Official (服务号) account:

WeChat will contact you to verify your information and provide an agreement you need to sign. Once approved, you can accept WeChat Pay payments initiated using the WeChat browser.

Build your payment form for WeChat Pay

Show WeChat Pay as an available payment method for shopper's accessing your mobile website the through the WeChat in-app browser.

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

Make a payment

When the shopper selects to pay with WeChat Pay:

  1. From your server, make a /payments request providing:

    • paymentMethod.type: wechatpayWeb
    • returnUrl: The URL of your payments page. The shopper is redirected to this page after they complete they verify the payment.
    curl https://checkout-test.adyen.com/v51/payments \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
      "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
      "reference":"YOUR_ORDER_NUMBER",
      "amount":{
        "currency":"CNY",
        "value":1000
      },
      "paymentMethod":{
        "type":"wechatpayWeb"
      },
      "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
    }'
    # Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen::Client.new
    adyen.api_key = "YOUR_X-API-KEY"
     
    response = adyen.checkout.payments({
      :amount => {
        :currency => "CNY",
        :value => 1000
      },
      :reference => "YOUR_ORDER_NUMBER",
      :paymentMethod => {
        :type => "wechatpayWeb"
      },
      :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
      :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
    })
    // Set YOUR_X-API-KEY with the API key from the Customer Area.
    // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
        Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
        Checkout checkout = new Checkout(client);
    
        PaymentsRequest paymentsRequest = new PaymentsRequest();
    
        String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
        paymentsRequest.setMerchantAccount(merchantAccount);
    
        Amount amount = new Amount();
        amount.setCurrency("CNY");
        amount.setValue(15000L);
        paymentsRequest.setAmount(amount);
    
        DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
        paymentMethodDetails.setType("wechatpayWeb");
        paymentsRequest.setPaymentMethod(paymentMethodDetails);
    
        paymentsRequest.setReference("YOUR_ORDER_NUMBER");
        paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
    
        PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    $client = new \Adyen\Client();
    $client->setXApiKey("YOUR_X-API-KEY");
    $service = new \Adyen\Service\Checkout($client);
    
    $params = array(
      "amount" => array(
        "currency" => "CNY",
        "value" => 1000
      ),
      "reference" => "YOUR_ORDER_NUMBER",
      "paymentMethod" => array(
        "type" => "wechatpayWeb"
      ),
      "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
      "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
    );
    $result = $service->payments($params);
    #Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen.Adyen()
    adyen.client.xapikey = 'YOUR_X-API-KEY'
    
    result = adyen.checkout.payments({
       'amount': {
          'value': 1000,
          'currency': 'CNY'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'paymentMethod': {
          'type': 'wechatpayWeb'
       },
       'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
       'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
    })
    // Set your X-API-KEY with the API key from the Customer Area.
    var client = new Client ("YOUR_X-API-KEY", Environment.Test);
    var checkout = new Checkout(client);
    
    var amount = new Model.Checkout.Amount("CNY", 1000);
    var details = new Model.Checkout.DefaultPaymentMethodDetails{
      Type = "wechatpayWeb"
    };
    var paymentsRequest = new Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
      MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
      PaymentMethod = details
    };
    
    var paymentResponse = checkout.Payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
    const config = new Config();
    // Set your X-API-KEY with the API key from the Customer Area.
    config.apiKey = '[API_KEY]';
    config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
    const client = new Client({ config });
    client.setEnvironment("TEST");
    const checkout = new CheckoutAPI(client);
    checkout.payments({
        amount: { currency: "CNY", value: 1000 },
        paymentMethod: {
            type: 'wechatpayWeb'
        },
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount,
        returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
    }).then(res => res);

    The /payments response contains:

    • action: Object containing information about the redirect.
    • paymentData: Value that you need when verifying the payment result.
    {
        "resultCode": "RedirectShopper",
        "action": {
            "method": "GET",
            "paymentData": "Ab02b4c0!BQABAgAEolM..",
            "paymentMethodType": "wechatpayWeb",
            "type": "redirect",
            "url": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=wechatpay&..."
        },
        "details": [
            {
                "key": "payload",
                "type": "text"
            }
        ],
         ...
        }
    }
  2. Proceed to the next step to handle the redirect. You will need to use the information in the action object to redirect the shopper to complete the payment.

Handle the redirect

To complete a WeChat Pay payment, you need to redirect the shopper to the URL provided in the /payments response. This prompts the shopper to enter their WeChat Pay PIN to verify the payment. After they complete the verification, they are redirected back to your mobile website using the returnUrl you specified earlier.

After the shopper is redirected back to your website or app, make a /payments/details request to check the payment result.

For more information and detailed instructions, refer to Handling redirects.

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.
Cancelled The shopper cancelled the payment while on the WeChat app. Ask the shopper whether they want to continue with the order, or request that they select a different payment method.
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
Received
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 notification. 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:

  • Making live WeChat Pay payments with a low value.
  • Or cancelling the transaction when you are asked to verify the payment.

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