WeChat Pay Drop-in integration

Add WeChat Pay to an existing Drop-in integration.

Our Web Drop-in renders WeChat Pay in your payment form, presents a WeChat Pay QR code, and provides the payment result.

Before you begin

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

Before starting your WeChat Pay integration:

Make sure that you have set up your back end implementation, and added Drop-in to your payments form.
Add WeChat Pay in your test Customer Area.
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

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:

countryCode: Any supported country. For example, CN.
amount.currency: Any supported currency. For example, CNY.

Make a payment

When the shopper selects to pay, Drop-in calls the onSubmit event, which contains a state.data.

Pass the state.data to your server.

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

paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.

https://docs.adyen.com/payment-methods/wechat-pay/wechat-pay-desktop-qr-payments/web-drop-in#wechat-payments

curl https://checkout-test.adyen.com/v67/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
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "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 => 1000
  },
  :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(15000L);
    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" => 1000
  ),
  "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': 1000,
      '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", 1000);
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: 1000 },
    paymentMethod: {
        type: 'wechatpayQR'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount
}).then(res => res);

https://docs.adyen.com/payment-methods/wechat-pay/wechat-pay-desktop-qr-payments/web-drop-in#-payments-response

/payments response

{
    "resultCode": "Pending",
    "action": {
        "paymentData": "Ab02b4c0!BQABAgC..",
        "paymentMethodType": "wechatpayQR",
        "qrCodeData": "weixin://wxpay/bizpayurl?pr=Gt7QlzU",
        "type": "qrCode"
    }
}

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.

Pass the action object to your front end. Drop-in needs the action object to present the QR code.

Present the QR code

Drop-in uses the dropin.handleAction function to present 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.

After the shopper completes the payment or if the shopper fails to complete the payment within the QR code validity period, Drop-in calls the onAdditionalDetails event.

Get the state.data from the onAdditionalDetails event and pass it your server.

https://docs.adyen.com/payment-methods/wechat-pay/wechat-pay-desktop-qr-payments/web-component#state-data-from-onadditionaldetails

state.data from onAdditionalDetails

{
      data: {
        details: {
            payload: "X6XtfGC3!Y..."
        },
       paymentData: "Ab02b4c0!BQABAgC.."
     }
  }

Check the payment result

To check the payment result, make a /payments/details request containing the state.data from Drop-in.

https://docs.adyen.com/payment-methods/wechat-pay/wechat-pay-desktop-qr-payments/web-drop-in#details-request-qr-payload

curl https://checkout-test.adyen.com/v67/payments/details \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
     "paymentData":"Ab02b4c0!BQABAgC..",
     "details":{
       "payload":"X6XtfGC3!Y..."
     }
}'

require 'adyen-ruby-api-library'

# 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"

response = adyen.checkout.payments.details({
  :paymentData => 'Ab02b4c0!BQABAgC..',
  :details => {
    :payload => 'X6XtfGC3!Y...'
  }
})

// Set your X-API-KEY with the API key from the Customer Area.
String xApiKey = "YOUR_X-API-KEY";
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", "X6XtfGC3!Y...");
paymentsDetailsRequest.setDetails(details);
paymentsDetailsRequest.setPaymentData("Ab02b4c0!BQABAgC..");
PaymentsResponse paymentsDetailsResponse = checkout.paymentsDetails(paymentsDetailsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setEnvironment(\Adyen\Environment::TEST);
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "paymentData" => "Ab02b4c0!BQABAgC..",
  "details" => array(
    "payload" => "X6XtfGC3!Y..."
  )
);
$result = $service->paymentsDetails($params);

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.payment.client.platform = "test"
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments_details({
   'paymentData' : 'Ab02b4c0!BQABAgC..',
   'details': {
      'payload': 'X6XtfGC3!Y...'
   }
})

// Set your X-API-KEY with the API key from the Customer Area.
string apiKey = "YOUR_X-API-KEY";
var client = new Client (apiKey, Environment.Test);
var checkout = new Checkout(client);
var details = new Dictionary<string, string>
{
  { "payload", "X6XtfGC3!Y..." }
};
var paymentsDetailsRequest = new Adyen.Model.Checkout.PaymentsDetailsRequest(Details: details);
var paymentsDetailsResponse = checkout.PaymentsDetails(paymentsDetailsRequest);

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 = '[YOUR_X-API-KEY]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.paymentsDetails({
    details: { payload: "X6XtfGC3!Y..." },
    paymentData: "Ab02b4c0!BQABAgC..",
}).then(res => res);

import (
    "github.com/adyen/adyen-go-api-library/v5/src/checkout"
    "github.com/adyen/adyen-go-api-library/v5/src/common"
    "github.com/adyen/adyen-go-api-library/v5/src/adyen"
)
// Set your X-API-KEY with the API key from the Customer Area.
client := adyen.NewClient(&common.Config{
    Environment: common.TestEnv,
    ApiKey:      "[YOUR_X-API-KEY]",
})
req := checkout.DetailsRequest{
PaymentData: "Ab02b4c0!BQABAgC..",
    Details: map[string]interface{}{
        "payload":    "X6XtfGC3!Y...",
    },
res, httpRes, err := client.Checkout.PaymentsDetails(&req)

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.