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.

WeChat Pay is supported from Android Components version 3.5.0 and later. For more information, see release notes.

Our WeChat Pay Component 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 Components integration. The Android 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 for making API requests.
  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

To show WeChat Pay Component in your payment form, you need to:

  1. Specify in your /paymentMethods request:

  2. Deserialize the response from the /paymentMethods call and get the object with type: wechatpaySDK.
  3. Add the WeChat Pay Component:

    a. Import the WeChat Pay Component to your build.gradle file.

    implementation "com.adyen.checkout:wechatpay-base:<latest-version>"

    Check the latest version on GitHub.

    b. Create a weChatPayConfiguration object:

    val weChatPayConfiguration =
           weChatPayConfiguration.Builder(this@YourActivity)
           .build()

    c. Check if WeChat is available on the shopper's device. If WeChat is available and the shopper chooses to pay with WeChat Pay, initialize the Component.

    var weChatPayComponent: WeChatPayComponent
    WeChatPayComponent.PROVIDER.isAvailable(this.application, paymentMethod, weChatPayConfiguration) { 
       isAvailable: Boolean, paymentMethod: PaymentMethod, weChatPayConfiguration: WeChatPayConfiguration? ->
       if (isAvailable) {
           weChatPayComponent = WeChatPayComponent.PROVIDER.get(this@YourActivity, paymentMethod, weChatPayConfiguration)
       }
    }

    The Component will immediately return isValid as true. Pass the paymentComponentState.data.paymentMethod to your server and make a payment request.

    weChatPayComponent.observe(this@MainActivity, Observer {
      if (it?.isValid == true) {
          // When the shopper proceeds to pay, pass the `it.data` to your server to send a /payments request
      }
    })

Make a payment

  1. Pass the paymentComponentState.data.paymentMethod to your server.
  2. From your server, make a /payments request, specifying:

    • paymentMethod.type: The paymentComponentState.data.paymentMethod from your client app.
    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":"wechatpaySDK"
      }
    }'
    # 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 => "wechatpaySDK"
      },
      :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("wechatpaySDK");
        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" => "wechatpaySDK"
      ),
      "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': 'wechatpaySDK'
       },
       '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 = "wechatpaySDK"
    };
    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: 'wechatpaySDK'
        },
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount
    }).then(res => res);

    The /payments response contains:

    • action: Object containing information about the app switch.
    {
        "resultCode": "Pending",
        "action": {
            "paymentData": "Ab02b4c0!BQABAgAgx==...",
            "paymentMethodType": "wechatpaySDK",
            "type": "wechatpaySDK",
            "sdkData": {
                "appid": "wx3aed7fe146f6a57a",
                "noncestr": "cPY0e83ny4hWyf5O",
                "packageValue": "Sign=WXPay",
                "partnerid": "205287714",
                "prepayid": "wx015678064827111da2e4f0b11005864100",
                "sign": "169FD3F1E193446D90C45573EBDD4020",
                "timestamp": "1573033086"
            }
        },
        "details": [
            {
                "key": "resultCode",
                "type": "text"
            }
        ],
        ...
    }
  3. Pass the action object to your client app. The WeChat Pay Action Component needs this to trigger the app switch to the WeChat app, where the shopper can proceed to complete the payment.

Handle the app switch

  1. Initialize the WeChat Pay Action Component to switch the shopper to the WeChat app.
    val wechatPayActionComponent = WeChatPayActionComponent.PROVIDER.get(this@YourActivity)
    WeChatPayActionComponent.handleAction(this@YourActivity, action)
  1. Get the resultIntent from the WeChat Pay SDK and pass it back to the Component.
override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    if (WeChatPayUtils.isResultIntent(intent)) {
        weChatPayActionComponent.handleWeChatPayResponse(intent)
    }
}
  1. The Component notifies the observer with the actionComponentData.details. Pass this to your server.
wechatPayActionComponent.observe(this, Observer {
   // Send a /payments/details/ call containing the `actionComponentData.details`
})

Check the payment result

When the shopper returns to your app, the Component provides the actionComponentData.

  1. Pass the actionComponentData.details to your server.
  2. From your server, make a /payments/details request containing the actionComponentData.details to check the payment result.

    curl https://checkout-test.adyen.com/v51/payments/details \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
       "{hint:actionComponentData from app}details{/hint}": {
          "resultCode": "0"
       },
       "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_ACTION_COMPONENT_DATA
    #  Data object passed from actionComponentData from the client app, 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("resultCode", "0");
    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_ACTION_COMPONENT_DATA;
    //  Data object passed from actionComponentData from the client app, 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_ACTION_COMPONENT_DATA
    #  Data object passed from actionComponentData from the client app, 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>
    {
      { "resultCode", "0" }
    };
    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_ACTION_COMPONENT_DATA}  // Data object passed from the client app.
    }).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 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