小程序支付下单

更新时间：2024.11.18

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

接口说明

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

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

请求域名：【主域名】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)

【合作伙伴小程序AppID】用户在合作伙伴的小程序内选购并付款的微信小程序AppID。与特约商户小程序AppID(sub_appid)二选一必填。
支付过程中将基于该ID验证对应的用户标识（OpenID）。

sp_mchid 　必填 string(32)

【合作伙伴商户号】合作伙伴商户号，由微信支付生成并下发。

sub_appid 　选填 string(32)

【特约商户小程序AppID】用户在特约商户的小程序内选购并付款的微信小程序AppID。与合作伙伴小程序AppID(sp_appid)二选一必填。
支付过程中将基于该ID验证对应的用户标识（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必须为通过公网可访问的HTTPS协议域名，且不能携带参数。

goods_tag 　选填 string(32)

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

support_fapiao 　选填 boolean

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

amount 　必填 object

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

属性

total 　必填 integer

【总金额】订单总金额，单位为分，只能为整数，详见交易金额。

currency 　选填 string(32)

【货币类型】符合 ISO 4217 标准的三位字母代码，目前只支持人民币：CNY。

payer 　必填 object

【支付者】支付者信息。

属性

sp_openid 　选填 string(128)

【用户标识】用户在合作伙伴小程序AppID的唯一标识。与用户子标识(sub_openid)二选一必填。
传入合作伙伴用户标识openid时需对应传入合作伙伴appid。
下单前需调用「小程序授权获取用户信息」接口获取到用户的OpenID。

sub_openid 　选填 string(128)

【用户子标识】用户在特约商户小程序AppID的唯一标识。与用户标识(sp_openid)二选一必填。
传入特约商户用户标识sub_openid时需对应传入特约商户sub_appid。
下单前需调用「小程序授权获取用户信息」接口获取到用户的OpenID。

detail 　选填 object

【优惠功能】优惠功能。

属性

cost_price 　选填 integer

【订单原价】 1.商户侧一张小票订单可能被分多次支付，订单原价用于记录整张小票的交易金额。 2.当订单原价与支付金额不相等，则不享受优惠。 3.该字段主要用于防止同一张小票分多次支付，以享受多次优惠的情况，正常支付订单不必上传此参数。

invoice_id 　选填 string(32)

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

goods_detail 　选填 array[object]

【单品列表】单品列表。

属性

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。

device_id 　选填 string(32)

【商户端设备号】商户端设备号。

store_info 　选填 object

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

属性

id 　选填 string(64)

【门店ID】此参数与商家自定义编码(out_id)二选一必填。
微信支付线下场所ID，格式为纯数字。
基于合规要求与风险管理目的，线下条码支付时需传入用户实际付款的场景信息。
指引参见：微信支付门店编号查询。

out_id 　选填 string(64)

【商家自定义编码】此参数与门店(id)二选一必填。
商户系统的门店编码，支持大小写英文字母、数字，仅支持utf-8格式。
基于合规要求与风险管理目的，线下条码支付时需传入用户实际付款的场景信息。

settle_info 　选填 object

【结算信息】结算信息。

属性

profit_sharing 　选填 boolean

【是否指定分账】是否指定分账，枚举值:true：是false：否。

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/pay/partner/transactions/miniprogram \
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    "support_fapiao" : true,
18    "amount" : {
19      "total" : 888,
20      "currency" : "CNY"
21    },
22    "payer" : {
23      "sp_openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o\t",
24      "sub_openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o\t"
25    },
26    "detail" : {
27      "cost_price" : 1,
28      "invoice_id" : "wx123",
29      "goods_detail" : [
30        {
31          "merchant_goods_id" : "由半角的大小写字母、数字、中划线、下划线中的一 种或几种组成 ",
32          "wechatpay_goods_id" : "微信支付定义的统一商品编号（没有可不传）",
33          "goods_name" : "iPhone6s 16G",
34          "quantity" : 1,
35          "unit_price" : 528800
36        }
37      ]
38    },
39    "scene_info" : {
40      "payer_client_ip" : "14.23.150.211",
41      "device_id" : "013467007045764",
42      "store_info" : {
43        "id" : "0001",
44        "out_id" : "example_out_id"
45      }
46    },
47    "settle_info" : {
48      "profit_sharing" : false
49    }
50  }'
51

应答参数

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	系统异常，请稍后重试	请稍后重试

文档是否有帮助

更多支持

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

小程序支付下单

接口说明

请求参数 折叠全部参数

应答参数

错误码

公共错误码

请求参数
折叠全部参数