JSAPI下单

更新时间：2024.11.18

商户系统先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易会话标识后再按Native、JSAPI、App等不同场景生成交易串调起支付。

接口说明

支持商户：【普通服务商】　【平台商户】

请求方式：【POST】/v3/pay/partner/transactions/jsapi

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数
折叠全部参数

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

Content-Type 　必填　string

请设置为application/json

body 包体参数

sp_appid 　必填 string(32)

【服务商应用ID】由微信生成的应用ID，全局唯一。请求基础下单接口时请注意AppID的应用属性，例如公众号场景下，需使用应用属性为公众号的服务号AppID

sp_mchid 　必填 string(32)

【服务商户号】服务商户号，由微信支付生成并下发

sub_appid 　选填 string(32)

【子商户/二级商户应用ID】子商户/二级商户在开放平台申请的应用AppID，全局唯一。请求基础下单接口时请注意AppID的应用属性，例如公众号场景下，需使用应用属性为公众号的APPID

若sub_openid有传的情况下，sub_appid必填，且sub_appid需与sub_openid对应

sub_mchid 　必填 string(32)

【子商户号/二级商户号】子商户/二级商户的商户号，由微信支付生成并下发。

description 　必填 string(127)

【商品描述】商品描述

out_trade_no 　必填 string(32)

【商户订单号】商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一。

time_expire 　选填 string(64)

【支付结束时间】
1、定义：支付结束时间是指用户能够完成该笔订单支付的最后时限，并非订单关闭的时间。超过此时间后，用户将无法对该笔订单进行支付。如商户需在超时后关闭订单，请调用关闭订单API接口。
2、格式要求：支付结束时间需遵循rfc3339标准格式：yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日；T 字符用于分隔日期和时间部分；HH:mm:ss 表示具体的时分秒；TIMEZONE 表示时区（例如，+08:00 对应东八区时间，即北京时间）。
示例：2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。
3、若未指定支付结束时间，系统默认以下单时间为起始点计算时效；超过 7 天未支付的订单，无法再支付。
4、注意事项：

若当前实际时间已超过订单设置的支付结束时间（time_expire），建议先使用关单接口关闭订单，再使用新的商户订单号重新下单，生成全新订单供用户支付。
支付结束时间不能早于下单时间后1分钟，若设置的支付结束时间早于该时间，系统将自动调整为下单时间后1分钟作为支付结束时间。
传递的支付结束时间需在下单时间的15天以内，如超过15天，微信支付会自动将该时间调整为下单时间后的第15天。

attach 　选填 string(128)

【附加数据】附加数据，在查询API和支付通知中原样返回，可作为自定义参数使用，实际情况下只有支付完成状态才会返回该字段。

notify_url 　必填 string(255)

【通知地址】异步接收微信支付结果通知的回调地址，通知URL必须为外网可访问的URL，不能携带参数。公网域名必须为HTTPS，如果是走专线接入，使用专线NAT IP或者私有回调域名可使用HTTP

goods_tag 　选填 string(32)

【订单优惠标记】订单优惠标记

settle_info 　选填 object

【结算信息】结算信息

属性

profit_sharing 　选填 boolean

【是否指定分账】是否指定分账，

枚举值:

true：是

false：否

support_fapiao 　选填 boolean

【电子发票入口开放标识】传入true时，支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能，传此字段才可生效。

true：是

false：否

amount 　必填 object

【订单金额】订单金额信息

属性

total 　必填 integer

【总金额】订单总金额，单位为分。

currency 　选填 string(16)

【货币类型】CNY：人民币，境内商户号仅支持人民币。

detail 　选填 object

【商品详情】商品详情描述，该结构去除多余空格换行压缩后，总长度不能超过6144字节。

属性

cost_price 　选填 integer

【订单原价】1、商户侧一张小票订单可能被分多次支付，订单原价用于记录整张小票的交易金额。

2、当订单原价与支付金额不相等，则不享受优惠。

3、该字段主要用于防止同一张小票分多次支付，以享受多次优惠的情况，正常支付订单不必上传此参数。

invoice_id 　选填 string(32)

【商品小票ID】商家小票ID

goods_detail 　选填 array[object]

【单品列表】订单商品明细列表，至少传入1条

属性

merchant_goods_id 　必填 string(32)

【商户侧商品编码】由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。

wechatpay_goods_id 　选填 string(32)

【微信支付商品编码】微信支付定义的统一商品编号（没有可不传）

goods_name 　选填 string(256)

【商品名称】商品的实际名称

quantity 　必填 integer

【商品数量】用户购买的数量

unit_price 　必填 integer

【商品单价】单位为：分。如果商户有优惠，需传输商户优惠后的单价(例如：用户对一笔100元的订单使用了商场发的纸质优惠券100-50，则活动商品的单价应为原单价-50)

scene_info 　选填 object

【场景信息】支付场景描述

属性

payer_client_ip 　必填 string(45)

【用户终端IP】用户的客户端IP，支持IPv4和IPv6两种格式的IP地址。

device_id 　选填 string(32)

【商户端设备号】商户端设备号（门店号或收银设备ID）。

store_info 　选填 object

【商户门店信息】商户门店信息

属性

id 　选填 string(32)

【门店编号】商户侧门店编号

name 　选填 string(256)

【门店名称】商户侧门店名称

area_code 　选填 string(32)

【地区编码】地区编码，详细请见省市区编号对照表。

address 　选填 string(512)

【详细地址】详细的商户门店地址

payer 　必填 object

【支付者】支付者信息。

sp_openid 和 sub_openid 两个字段必须要填一个

属性

sp_openid 　选填 string(128)

【用户服务标识】用户在服务商AppID下的唯一标识。下单前需获取到用户的OpenID，OpenID获取详见。

sub_openid 　选填 string(128)

【用户子标识】用户在子商户AppID下的唯一标识。若传sub_openid，那sub_appid必填。下单前需获取到用户的OpenID，OpenID获取详见。

identity 　选填 object

【实名支付】实名支付信息

属性

type 　必填 string(32)

【证件类型】证件类型，枚举值：
IDCARD:身份证
HONGKONG_MACAO:港澳回乡证
HONGKONG_MACAO_RESIDENT:港澳居住证
TAIWAN_RESIDENT:台湾居住证
FOREIGN_RESIDENT:外国人永居证
OVERSEA_PASSPORT:护照。

number 　必填 string(32)

【证件号】证件号，如身份证号

name 　必填 string(32)

【姓名】证件姓名

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/pay/partner/transactions/jsapi \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "sp_appid" : "wx8888888888888888",
8    "sp_mchid" : "1230000109",
9    "sub_appid" : "wxd678efh567hg6999",
10    "sub_mchid" : "1900000109",
11    "description" : "Image形象店-深圳腾大-QQ公仔",
12    "out_trade_no" : "1217752501201407033233368018",
13    "time_expire" : "2018-06-08T10:34:56+08:00",
14    "attach" : "自定义数据",
15    "notify_url" : " https://www.weixin.qq.com/wxpay/pay.php",
16    "goods_tag" : "WXG",
17    "settle_info" : {
18      "profit_sharing" : true
19    },
20    "support_fapiao" : true,
21    "amount" : {
22      "total" : 100,
23      "currency" : "CNY"
24    },
25    "detail" : {
26      "cost_price" : 608800,
27      "invoice_id" : "微信123",
28      "goods_detail" : [
29        {
30          "merchant_goods_id" : "1246464644",
31          "wechatpay_goods_id" : "1001",
32          "goods_name" : "iPhoneX 256G",
33          "quantity" : 1,
34          "unit_price" : 528800
35        }
36      ]
37    },
38    "scene_info" : {
39      "payer_client_ip" : "14.23.150.211",
40      "device_id" : "013467007045764",
41      "store_info" : {
42        "id" : "0001",
43        "name" : "腾讯大厦分店",
44        "area_code" : "440305",
45        "address" : "广东省深圳市南山区科技中一道10000号"
46      }
47    },
48    "payer": {
49      "sp_openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o\t",
50      "sub_openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o\t"
51      "identity": {
52        "type": "IDCARD",
53        "number": "420101200501261791",
54        "name": "卞添池"
55      }
56    }
57  }'
58

应答参数

200 OK

prepay_id 　必填 string(64)

【预支付交易会话标识】预支付交易会话标识。用于后续接口调用中使用，该值有效期为2小时

应答示例

200 OK

1{
2  "prepay_id" : "wx201410272009395522657a690389285100"
3}
4

错误码

公共错误码

状态码	错误码	描述	解决方案
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	系统错误	系统异常，请用相同参数重新调用

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服