Product Documentation General instructions Access Guidelines FAQs

Payment from HTML5 Websites

Update Time：2025.02.20

The JSAPI is called when the Payer opens an HTML5 website with a WeChat-supported browser. The input and output API data is in JSON format.

Tips：

WeixinJSBridge built-in objects are invalid in other browsers and parameter names in the list are case-sensitive.
"get_brand_wcpay_request:ok" is returned by the JSAPI only when the Payer completes the payment. For front-end logic, "get_brand_wcpay_request:cancel" or "get_brand_wcpay_request:fail" can be handled as payment exceptions.

API intro

Applicable object: Common mode Institutional mode

Request Parameters

Name	ID	Type	Required	Description
Official Account ID	appId	string(16)	Yes	This ID is issued after merchants apply for official account supporting WeChat payment. Example：wx8888888888888888
Timestamp	timeStamp	string(32)	Yes	Specifies the current time. For more information, see Timestamp in Parameter Specifications. Example：1414561699
Random string	nonceStr	string(32)	Yes	32 characters or fewer. For more information, see Random string Algorithm. Example：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
Order Extension string	package	string(128)	Yes	Specifies the parameter value (prepay_id) returned by the Unified Order API. The submission format is "prepay_id=***". Example：prepay_id=123456789
Signature	paySign	string(64)	Yes	Specifies a signature. For more information, see Signature Algorithm. Example：C380BEC2BFD727A4B6845133519F3AD6
Sign type	signType	string(32)	Yes	Currently HMAC-SHA256 and MD5 are supported, default is MD5. This parameter must be submitted if HMAC-SHA256 is chosen Example：MD5

Return Data

Field Name	Return Value	Description
success	get_brand_wcpay_request:ok	Payment successful
fail	get_brand_wcpay_request:cancel	Payment canceled
fail	get_brand_wcpay_request:fail	Payment failed
fail	Missing parameter for calling payment jsapi: total_fee.	1.Please check whether the prepayment session id "prepay_id" has expired. 2.Whether the appid currently used is consistent with the appid of the unified order API

Example：

1function onBridgeReady(){
2   WeixinJSBridge.invoke(
3       'getBrandWCPayRequest', {
4           "appId" : "wx2421b1c4370ec43b",     //Official Account name transferred by merchants     
5           "timeStamp":" 1395712654",         //Timestamp since 1.1.1970 UTC     
6           "nonceStr" : "e61463f8efa94090b1f366cccfbbb444", //Random string     
7           "package" : "prepay_id=u802345jgfjsdfgsdg888",     
8           "signType" : "MD5",         //WeChat signature type:     
9           "paySign" : "70EA570631E4BB79628FBCA90534C63FF7FADD89" //WeChat signature 
10       },
11       function(res){     
12           if(res.err_msg == "get_brand_wcpay_request:ok" ) {}     // Use the above method to determine values returned to the front-end. Please note that "res.err_msg" returns"ok" after a successful payment. However, WeChat doesn't guarantee its reliability. 
13       }
14   ); 
15}
16if (typeof WeixinJSBridge == "undefined"){
17   if( document.addEventListener ){
18       document.addEventListener('WeixinJSBridgeReady', onBridgeReady, false);
19   }else if (document.attachEvent){
20       document.attachEvent('WeixinJSBridgeReady', onBridgeReady); 
21       document.attachEvent('onWeixinJSBridgeReady', onBridgeReady);
22   }
23}else{
24   onBridgeReady();
25}