商户系统先调用该接口在微信支付服务后台生成预支付交易单,返回正确的预支付交易会话标识后再按Native、JSAPI、APP等不同场景生成交易串调起支付。
接口说明
支持商户:【普通商户】
请求方式:【POST】/v3/pay/transactions/jsapi
请求域名:【主域名】https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看
请求参数
HeaderHTTP头参数
- Authorization必填string
请参考 签名认证 生成认证信息 - Accept必填string
请设置为application/json
- Content-Type必填string
请设置为application/json
Body包体参数
-
appid必填string(32)
【公众号ID】 公众号ID -
mchid必填string(32)
【直连商户号】 直连商户号 -
description必填string(127)
【商品描述】 商品描述 -
out_trade_no必填string(32)
【商户订单号】 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一。 -
time_expire选填string(64)
【交易结束时间】 订单失效时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 -
attach选填string(128)
【附加数据】 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用,实际情况下只有支付完成状态才会返回该字段。 -
notify_url必填string(255)
【通知地址】 异步接收微信支付结果通知的回调地址,通知URL必须为外网可访问的URL,不能携带参数。 公网域名必须为HTTPS,如果是走专线接入,使用专线NAT IP或者私有回调域名可使用HTTP -
goods_tag选填string(32)
【订单优惠标记】 订单优惠标记 -
support_fapiao选填boolean
【电子发票入口开放标识】 传入true时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效。
true:是
false:否 -
amount必填CommReqAmountInfo
【订单金额】 订单金额信息- 属性
-
payer必填JsapiReqPayerInfo
【支付者】 支付者信息。- 属性
-
detail选填OrderDetail
【优惠功能】 优惠功能- 属性
-
scene_info选填CommReqSceneInfo
【场景信息】 支付场景描述- 属性
-
settle_info选填SettleInfo
【结算信息】 结算信息- 属性
请求示例
curl -X POST \
https://api.mch.weixin.qq.com/v3/pay/transactions/jsapi \
-H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"appid" : "wxd678efh567hg6787",
"mchid" : "1230000109",
"description" : "Image形象店-深圳腾大-QQ公仔",
"out_trade_no" : "1217752501201407033233368018",
"time_expire" : "2018-06-08T10:34:56+08:00",
"attach" : "自定义数据说明",
"notify_url" : " https://www.weixin.qq.com/wxpay/pay.php",
"goods_tag" : "WXG",
"support_fapiao" : true,
"amount" : {
"total" : 100,
"currency" : "CNY"
},
"payer" : {
"openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o\t"
},
"detail" : {
"cost_price" : 608800,
"invoice_id" : "微信123",
"goods_detail" : [
{
"merchant_goods_id" : "1246464644",
"wechatpay_goods_id" : "1001",
"goods_name" : "iPhoneX 256G",
"quantity" : 1,
"unit_price" : 528800
}
]
},
"scene_info" : {
"payer_client_ip" : "14.23.150.211",
"device_id" : "013467007045764",
"store_info" : {
"id" : "0001",
"name" : "腾讯大厦分店",
"area_code" : "440305",
"address" : "广东省深圳市南山区科技中一道10000号"
}
},
"settle_info" : {
"profit_sharing" : false
}
}'
应答参数
200OK
- prepay_id必填string(64)
【预支付交易会话标识】 预支付交易会话标识。用于后续接口调用中使用,该值有效期为2小时
应答示例
{
"prepay_id" : "wx201410272009395522657a690389285100"
}
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | AppID和mch_id不匹配 | 请确认AppID和mch_id是否匹配 |
400 | INVALID_REQUEST | 无效请求 | 请根据接口返回的详细信息检查 |
400 | MCH_NOT_EXISTS | 商户号不存在 | 请检查商户号是否正确 |
400 | ORDER_CLOSED | 订单已关闭 | 当前订单已关闭,请重新下单 |
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |
403 | ACCOUNT_ERROR | 账号异常 | 用户账号异常,无需更多操作 |
403 | NO_AUTH | 商户无权限 | 请商户前往申请此接口相关权限 |
403 | OUT_TRADE_NO_USED | 商户订单号重复 | 请核实商户订单号是否重复提交 |
403 | RULE_LIMIT | 业务规则限制 | 因业务规则限制请求频率,请查看接口返回的详细信息 |
403 | TRADE_ERROR | 交易错误 | 因业务原因交易失败,请查看接口返回的详细信息 |
404 | ORDER_NOT_EXIST | 订单不存在 | 请检查订单是否发起过交易 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |
500 | BANK_ERROR | 银行系统异常 | 银行系统异常,请用相同参数重新调用 |
500 | INVALID_TRANSACTIONID | 订单号非法 | 请检查微信支付订单号是否正确 |
500 | OPENID_MISMATCH | OpenID和AppID不匹配 | 请确认OpenID和AppID是否匹配 |
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请用相同参数重新调用 |