JSAPI拉起支付

更新时间：2025.01.07

在微信浏览器里面打开H5网页中执行JS调起支付。接口输入输出数据格式为JSON。

注意：

WeixinJSBridge内置对象在其他浏览器中无效。

列表中参数名区分大小，大小写错误签名验证会失败。

1. 接口说明

适用对象: 直连模式机构模式

2. 接口定义

此API无后台接口交互，需要将列表中的数据签名

参数名	变量	类型[长度限制]	必填	描述
公众号id	appId	string[1,16]	是	商户注册具有支付权限的公众号成功后即可获得示例值：wx8888888888888888
时间戳	timeStamp	string[1,32]	是	当前的时间，其他详见时间戳规则示例值：1414561699
随机字符串	nonceStr	string[1,32]	是	随机字符串，不长于32位。推荐随机数生成算法示例值：5K8264ILTKch16CQ2502SI8ZNMTM67VS
订单详情扩展字符串	package	string[1,128]	是	JSAPI下单接口返回的prepay_id参数值，提交格式如：prepay_id=*** 示例值：prepay_id=wx201410272009395522657a690389285100
签名方式	signType	string[1,32]	是	签名类型，默认为RSA,该参数不参与签名示例值：RSA
签名	paySign	string[1,64]	是	签名，使用字段appId、timeStamp、nonceStr、package计算得出的签名值示例值：C380BEC2BFD727A4B6845133519F3AD6

返回结果值说明

返回值	描述
get_brand_wcpay_request:ok	支付成功
get_brand_wcpay_request:cancel	支付过程中用户取消
get_brand_wcpay_request:fail	支付失败

3. paySign生成规则

3.1.构造签名串

签名串一共有四行，每一行为一个参数。行尾以\n（换行符，ASCII编码值为0x0A）结束，包括最后一行。如果参数本身以\n结束，也需要附加一个\n

参与签名字段及格式:

1   公众号id
2   时间戳
3   随机字符串
4   订单详情扩展字符串

待签名串举例：

1   wx8888888888888888
2   1414561699
3   5K8264ILTKch16CQ2502SI8ZNMTM67VS
4   prepay_id=123456789

3.2. 计算签名值：

绝大多数编程语言提供的签名函数支持对签名数据进行签名。强烈建议商户调用该类函数，使用商户私钥对待签名串进行SHA256 with RSA签名，并对签名结果进行Base64编码得到签名值。

下面我们使用命令行演示如何生成签名。

1$ echo -n -e \
2"wx8888888888888888\n1414561699\n5K8264ILTKCH16CQ2502SI8ZNMTM67VS\nprepay_id=wx201410272009395522657a690389285100\n" \
3  | openssl dgst -sha256 -sign apiclient_key.pem \
4  | openssl base64 -A
5  uOVRnA4qG/MNnYzdQxJanN+zU+lTgIcnU9BxGw5dKjK+VdEUz2FeIoC+D5sB/LN+nGzX3hfZg6r5wT1pl2ZobmIc6p0ldN7J6yDgUzbX8Uk3sD4a4eZVPTBvqNDoUqcYMlZ9uuDdCvNv4TM3c1WzsXUrExwVkI1XO5jCNbgDJ25nkT/c1gIFvqoogl7MdSFGc4W4xZsqCItnqbypR3RuGIlR9h9vlRsy7zJR9PBI83X8alLDIfR1ukt1P7tMnmogZ0cuDY8cZsd8ZlCgLadmvej58SLsIkVxFJ8XyUgx9FmutKSYTmYtWBZ0+tNvfGmbXU7cob8H/4nLBiCwIUFluw==

注意

signType参数不参与签名，但需要传递，默认值为“RSA”，生成的签名需要通过字段paySign传递。

示例代码如下：

示例

1function onBridgeReady() {
2	WeixinJSBridge.invoke(
3		'getBrandWCPayRequest', {
4			"appId": "wx2421b1c4370ec43b", //公众号名称，由商户传入     
5			"timeStamp": "1395712654", //时间戳，自1970年以来的秒数     
6			"nonceStr": "e61463f8efa94090b1f366cccfbbb444", //随机串     
7			"package": "prepay_id=u802345jgfjsdfgsdg888",
8			"signType": "RSA", //微信签名方式：     
9			"paySign": "70EA570631E4BB79628FBCA90534C63FF7FADD89" //微信签名 
10		},
11		function(res) {
12			if (res.err_msg == "get_brand_wcpay_request:ok") {} // 使用以上方式判断前端返回,微信团队郑重提示：res.err_msg将在用户支付成功后返回    ok，但并不保证它绝对可靠。 
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}