WeChat Pay 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:

1. Make sure that you have set up your back end implementation, and added Drop-in to your payments form.
2. Add WeChat Pay in your test Customer Area.

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 the Pay button, Drop-in calls the onSubmit event, which contains a state.data.

1. Pass the state.data to your server.

2. 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
   • Ruby
   • Java
   • PHP
   • Python
   • C#
   • NodeJS

   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
     },
     "{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 paymentsRequest = new 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": "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"
           }
       }
   }
3. 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. 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.

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

Check the payment result

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

curl https://checkout-test.adyen.com/v51  /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);
PaymentDetailsRequest paymentDetailsRequest = new PaymentDetailsRequest();
HashMap<String, String> details = new HashMap<>();
details.put("payload", "Ab02b4c0!BQABF...");
paymentsDetailsRequest.setDetails(details);
paymentsDetailsRequest.setPaymentData("Ab02b4c0!BQABAgAKspbjN8+5...");
PaymentsResponse paymentsResponse = checkout.paymentDetails(PaymentDetailsRequest);

// 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->paymentDetails($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:

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