APP下单并签约

更新时间:2025.12.31
||

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

接口说明

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

请求方式:【POST】/v3/pay/partner/transactions/app-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  包体参数

 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)

【交易结束时间】 订单失效时间,遵循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)

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


 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)

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


 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/partner/transactions/app-with-contract \
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    "contract_info" : {
49      "contract_appid":"wxcbda96de0b165486",
50      "contract_code":"100001256",
51      "request_serial":"1695",
52      "contract_display_account":"123456",
53      "contract_notify_url":"https://yoursite.com",
54      "contract_mchid":"1200009811",
55      "plan_id":"3484306348"
56    }
57  }'
58

应答参数

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
反馈
目录
置顶