WeChat Pay Drop-in integration

Our Android Drop-in renders WeChat Pay in your payment form, and triggers the app switch from your app to the WeChat app on the shopper's device.

Before you begin

This page explains how to add WeChat Pay to your existing Android Drop-in integration. The Android 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 in-app integration:

1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
2. Add WeChat Pay in your test Customer Area.
3. Create a developer account on the WeChat Open Platform.
4. Register your mobile app with WeChat.

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 proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

1. Pass the paymentComponentData.paymentMethod to your server.

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

   • paymentMethod: The paymentComponentData.paymentMethod from your client app.
   curl Ruby PHP Python NodeJS

   curl Ruby PHP Python NodeJS

   curl https://checkout-test.adyen.com/v69/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":"wechatpaySDK"
     },
     "returnUrl":"adyencheckout://your.package.name"
   }'

   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({
       :countryCode => "CN",
       :paymentMethod => {
         :type => "wechatpaySDK"
   
       },
       :amount => {
         :currency => "CNY",
         :value => 1000
       },
       :reference => "YOUR_ORDER_NUMBER",
       :shopperLocale => "en-GB",
       :shopperEmail => "s.hopper@example.com",
       :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       :returnUrl => "adyencheckout://your.package.name",
       :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
   })
   
   # Check if further action is needed.
   if response.body.has_key(:action)
      # Pass the action object to your front end
      # response.body[:action]
   else
      # No further action needed, pass the resultCode object to your front end
      # response.body[:resultCode]
   end

   // 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(
       "countryCode" => "CN",
       "paymentMethod" => [
           "type" => "wechatpaySDK"
        ],
       "amount" => array(
           "currency" => "CNY",
           "value" => 1000
       ),
       "reference" => "YOUR_ORDER_NUMBER",
       "shopperLocale" => "en-GB",
   
        "shopperEmail" => "s.hopper@example.com",
       "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       "returnUrl" => "adyencheckout://your.package.name",
       "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
   );
   $result = $service->payments($params);
   
   // Check if further action is needed
   if (array_key_exists("action", $result)){
      // Pass the action object to your front end
      // $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.payment.client.platform = "test"
   adyen.client.xapikey = 'YOUR_X-API-KEY'
   
   result = adyen.checkout.payments({
       "countryCode": "CN",
       "paymentMethod": {
           "type": "wechatpaySDK"
        },
       "amount": {
           "value": 1000,
           "currency": "CNY"
       },
       "reference": "YOUR_ORDER_NUMBER",
       "shopperLocale": "en-GB",
       "shopperEmail": "s.hopper@example.com",
       "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       "returnUrl": "adyencheckout://your.package.name",
       "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
   })
   
   # Check if further action is needed
   if 'action' in result.message:
       # Pass the action object to your front end# result.message['action']
       pass
   else:
       # No further action needed, pass the resultCode to your front end
       # result.message['resultCode']
       pass

   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]';
   config.merchantAccount = 'YOUR_MERCHANT_ACCOUNT';
   const client = new Client({ config });
   client.setEnvironment("TEST");
   const checkout = new CheckoutAPI(client);
   checkout.payments({
       merchantAccount: config.merchantAccount,
       countryCode: "CN",
       paymentMethod: {
           type: "wechatpaySDK"
       },
       amount: { currency: "CNY", value: 1000, },
       reference: "YOUR_ORDER_NUMBER",
       shopperLocale: "en-GB",
       shopperEmail: "s.hopper@example.com",
       shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       returnUrl: "adyencheckout://your.package.name",
   }).then(res => res);

   https://docs.adyen.com/payment-methods/wechat-pay/wechat-pay-in-app-payments/android-drop-in#wechat-payments-request-api

   The /payments response includes an action object that contains information about the app switch.

3. Pass the action object to your client app.

   /payments response

   {
       "resultCode": "Pending",
       "action": {
           "paymentMethodType": "wechatpaySDK",
           "type": "sdk",
           "sdkData": {
               "appid": "wx3aed7fe146f6a57a",
               "noncestr": "cPY0e83ny4hWyf5O",
               "packageValue": "Sign=WXPay",
               "partnerid": "205287714",
               "prepayid": "wx015678064827111da2e4f0b11005864100",
               "sign": "169FD3F1E193446D90C45573EBDD4020",
               "timestamp": "1573033086"
           }
       },
       "details": [
           {
               "key": "resultCode",
               "type": "text"
           }
       ],
       ...
   }

   https://docs.adyen.com/payment-methods/wechat-pay/wechat-pay-in-app-payments/android-drop-in#-payments-response

Check the payment result

Drop-in uses the action object to launch the WeChat app, where the shopper completes the payment, and is then redirected back to your app.

To check the payment result, make a /payments/details request.

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:

• 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