Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

WeChat Pay Component

Add WeChat Pay to an existing Components integration.

Our WeChat Pay Component presents the WeChat Pay QR code and provides the payment result.

When making a WeChat Pay payment, you additionally need to:

Before you begin

This page explains how to add WeChat Pay to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your WeChat Pay integration:

  1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
  2. Add WeChat Pay in your test Customer Area.
  1. Optional: Contact our Support Team to enable live WeChat Pay transactions for your Adyen test account.

    WeChat do not provide QR codes for testing purposes. If you want to test the WeChat Pay QR flow, you will need to do this with a live WeChat Pay transaction. You can cancel this transaction in the WeChat Pay app to prevent it from being processed.

    If live WeChat Pay transactions are not enabled for your Adyen test account, you will receive a 903 Internal error message when making a payment.

Show WeChat Pay in your payment form

Show WeChat Pay as an available payment method in your payment form.

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:

Make a payment

  1. When the shopper selects to pay with WeChat Pay, make a POST /payments request, specifying:

    • paymentMethod: wechatpayQR

    Here is how you would make a payment request for 100 CNY.

    curl https://checkout-test.adyen.com/v53/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":10000
      },
      "paymentMethod":{
        "type":"wechatpayQR"
      }
    }'
    # 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 => 10000
      },
      :reference => "YOUR_ORDER_NUMBER",
      :paymentMethod => {
        :type => "wechatpayQR"
      },
      :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(10000L);
        paymentsRequest.setAmount(amount);
    
        DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
        paymentMethodDetails.setType("wechatpayQR");
        paymentsRequest.setPaymentMethod(paymentMethodDetails);
    
        paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    
        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" => 10000
      ),
      "reference" => "YOUR_ORDER_NUMBER",
      "paymentMethod" => array(
        "type" => "wechatpayQR"
      ),
      "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': 10000,
          'currency': 'CNY'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'paymentMethod': {
          'type': 'wechatpayQR'
       },
       '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", 10000);
    var details = new Model.Checkout.DefaultPaymentMethodDetails{
      Type = "wechatpayQR"
    };
    var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      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: 10000 },
        paymentMethod: {
            type: 'wechatpayQR'
        },
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount
    }).then(res => res);
    /payments response
    {
        "resultCode": "PresentToShopper",
        "action": {
            "paymentData": "Ab02b4c0!BQABAgCpM2q6...==",
            "paymentMethodType": "wechatpayQR",
            "qrCodeData": "weixin://wxpay/bizpayurl?pr=Gt7QlzU",
            "type": "qrCode"
        },
        "details": [
            {
                "key": "payload",
                "type": "text"
            }
        ],
        "paymentData": "Ab02b4c0!BQABAgCpM2q6...==",
        "redirect": {
            "data": {
                "qrCodeData": "weixin://wxpay/bizpayurl?pr=Gt7QlzU"
            }
        }
    }

    If you have not enabled live WeChat Pay transactions for your Adyen test account, you will get a 903 Internal error message in the response. For more information, see the Before you begin section on this page.

  2. Pass the action object to your front end. The Component needs the action object to present the WeChat Pay QR code.

Present the QR code

  1. Create a DOM element for WeChat Pay, placing it where you want the QR code to be rendered:

    <div id="wechatpayqr-container"></div>
  2. Call createFromAction and pass the action object from the /payments response.

    checkout.createFromAction(action).mount('#wechatpayqr-container');

    The Component presents the QR code.

    For testing purposes, you can scan this QR code in the WeChat Pay app, then cancel the transaction when you are asked to verify the payment. This will prevent the live transaction from being processed.

    The onAdditionalDetails event is called by the Component after the shopper either completes the payment, or fails to do so within the QR code validity period.

  3. Pass the state.data from the onAdditionalDetails event to your server.

    state from onAdditionalDetails
    {
     data: {
        details: {
          payload: "Ab02b4c0!BQABF..."
        },
        paymentData: "Ab02b4c0!BQABAgAKspbjN8+5..."
     }
    }

Check the payment result

To check the payment result, make a /payments/details request with the state.data from the Component.

curl https://checkout-test.adyen.com/v53/payments/details \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
   "{hint:state.data from onAdditionalDetails}details{/hint}": {
      "payload": "Ab02b4c0!BQABF..."
   },
   "paymentData":"Ab02b4c0!BQABAgAKspbjN8+5..."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.env = :test
adyen.api_key = "YOUR_X-API-KEY"

request = DROPIN_DATA
# Data object passed from onAdditionalDetails event of the front end, parsed from JSON to a Hash.

response = adyen.checkout.payments.details(request)

# Check if further action is needed.
if response.body.has_key(:action)
   # Pass the action object to your frontend
   puts response.body[:action]
else
   # No further action needed, pass the resultCode to your frontend
   puts response.body[:resultCode]
end
// Set your X-API-KEY with the API key from the Customer Area.
Client client = new Client(xApiKey,Environment.TEST);

Checkout checkout = new Checkout(client);
PaymentsDetailsRequest paymentsDetailsRequest = new PaymentsDetailsRequest();
HashMap<String, String> details = new HashMap<>();
details.put("payload", "Ab02b4c0!BQABF...");
paymentsDetailsRequest.setDetails(details);
paymentsDetailsRequest.setPaymentData("Ab02b4c0!BQABAgAKspbjN8+5...");
PaymentsResponse paymentsResponse = checkout.paymentsDetails(paymentsDetailsRequest);
// 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 = DROPIN_DATA;
// Data object passed from onAdditionalDetails event of the front end parsed from JSON to an array

$result = $service->paymentsDetails($params);

// Check if further action is needed
if (array_key_exists("action", $result){
   // Pass the action object to your frontend.
   // $result["action"]
}
else {
   // No further action needed, pass the resultCode to your front end
   // $result['resultCode']
}
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

request = DROPIN_DATA
# Data object passed from onAdditionalDetails event of the front end, parsed from JSON to a dictionary

result = adyen.checkout.payments_details(request)

# Check if further action is needed.
if 'action' in result.message:
   # Pass the action object to your front end
   # result.message['action']
else:
   # No further action needed, pass the resultCode to your front end
   # result.message['resultCode']
// 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);
string paymentData = "Ab02b4c0!BQABAgAKspbjN8+5...";

var details = new Dictionary<string, string>
{
  { "payload", "Ab02b4c0!BQABF..." }
};
var paymentsDetailsRequest = new Model.Checkout.PaymentsDetailsRequest(Details: details);
var paymentResponse = checkout.PaymentDetails(paymentsDetailsRequest);
// 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.paymentsDetails({
    details: {DROPIN_DATA}  // Data object passed from onAdditionalDetails event of the front end
}).then(res => res);

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 ask them to 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 or
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:

  • 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