JSAPI下单并签约

更新时间:2025.12.31

调用该接口在微信支付服务后台生成预支付交易单,返回正确的预支付交易会话标识后再按JSAPI方式调起支付。后续调起支付会引导用户签约。

接口说明

支持商户:【普通商户】

请求方式:【POST】/v3/pay/transactions/jsapi-with-contract

请求域名:【主域名】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  包体参数

 appid  必填   string(32)

【公众号ID】 公众号ID


 mchid  必填   string(32)

【直连商户号】 直连商户号


 description  必填   string(127)

【商品描述】 商品描述


 out_trade_no  必填   string(32)

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

特殊规则:最小字符长度为6


 time_expire  选填   string(64)

【交易结束时间】 订单生成时间,格式为rfc3339格式,如 2018-06-08T10:34:56+08:00 代表北京时间 2018年06月08日10时34分56秒。


 attach  选填   string(128)

【附加数据】 附加数据


 notify_url  必填   string(255)

【通知地址】 有效性:1. HTTPS;2. 不允许携带查询串。


 goods_tag  选填   string(32)

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


 support_fapiao  选填   boolean

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


 amount  必填   object

【订单金额】 订单金额

属性

 total  必填   integer

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


 currency  选填   string(16)

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


 payer  必填   object

【支付者】 支付者

属性

 openid  必填   string(128)

【用户标识】 用户在商户AppID下的唯一标识。


 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)

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


 settle_info  选填   object

【结算信息】 结算信息

属性

 profit_sharing  选填   boolean

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

枚举值:

true:是

false:否


 contract_info  必填   object

【预签约信息】 扣费服务预签约信息

属性

plan_id  必填 string(10)

【模板ID】 协议模板ID


contract_mchid  必填 string(12)

【签约商户号】 签约商户号,必须与mch_id一致


contract_appid  必填 string(32)

【签约AppID】 签约公众号,必须与AppID一致


contract_code  必填 string(64)

【签约协议号】 签约协议号


request_serial  必填 string(19)

【请求序列号】 商户请求签约时的序列号,要求唯一性。序列号主要用于排序,不作为查询条件,纯数字,范围不能超过Int64的范围(9223372036854775807)


contract_display_account  必填 string(64)

【用户账户展示名称】 签约用户的名称,用于页面展示,参数值不支持UTF8非3字节编码的字符,例如表情符号,所以请勿传微信昵称到该字段


contract_notify_url  选填 string(255)

【签约信息通知URL】 签约信息回调通知的URL

请求示例

curl
Java
Go

POST

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

应答参数

200 OK

 prepay_id  必填   string(64)

【预支付交易会话标识】 预支付交易会话标识

应答示例

200 OK

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

 

错误码

以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

403

NO_AUTH

商户无权限

请联系微信支付技术支持

 

 

元宝AI
反馈
目录
置顶