查询合单订单

更新时间:2025.01.17

合单支付下单成功后,服务商(合单发起方)可调用该接口查询合单订单的交易状态。

注意:

请勿使用非合单支付的查单接口查询合单订单。

接口说明

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

请求方式:【GET】/v3/combine-transactions/out-trade-no/{combine_out_trade_no}

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

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

请求参数

Header  HTTP头参数

 Authorization  必填 string

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


 Accept  必填 string

请设置为application/json


path  路径参数

 combine_out_trade_no  必填   string(32)

【合单商户订单号】下单时传入的合单商户订单号。

请求示例

curl
Java
Go

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/combine-transactions/out-trade-no/P20150806125346 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数
折叠全部参数

200 OK

 combine_appid  必填   string(32)

【合单服务商APPID】下单时传入的服务商的APPID。


 combine_mchid  必填   string(32)

【合单服务商商户号】下单时传入的服务商商户号。


 combine_payer_info  选填   object

【合单支付者信息】 合单订单支付者的信息,支付成功后返回。

属性

 openid  选填   string(128)

【用户服务商标识】实际支付的用户在combine_appid下对应的openid


 sub_orders  选填   array[object]

【商品单信息】商品单列表。

属性

 mchid  必填   string(32)

【商品单商户号】合单下单时传入的服务商商户号


 trade_type  选填   string

【交易类型】 当前订单的交易类型,支付成功后返回,枚举值:
JSAPI:JSAPI合单支付、小程序合单支付
NATIVE:Native合单支付
APP:APP合单支付
MWEB:H5合单支付


 trade_state  必填   string

【交易状态】 交易状态,详细业务流转状态处理请参考开发指引-订单状态流转图。枚举值:
SUCCESS:支付成功
NOTPAY:未支付
CLOSED:已关闭


 bank_type  选填   string(32)

【银行类型】 用户支付方式,订单支付成功后返回,
1、使用银行卡支付,例如工商银行借记卡,该字段返回 ICBC_DEBIT,更多银行类型请参考《银行类型对照表
2、使用非银行卡支付,例如余额/零钱通等,该字段统一返回OTHERS


 attach  选填   string(128)

【商户数据包】服务商下单时传入的自定义数据包,用户不可见,长度不超过128字符,若下单传入该参数,则订单支付成功后此接口和合单订单支付成功回调通知接口以及交易账单中会原样返回;若下单未传该参数,则不会返回。


 success_time  选填   string(32)

【支付完成时间】
1、定义:用户完成订单支付的时间。
2、格式遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONEyyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。


 amount  选填   object

【商品单金额信息】 商品单收款金额信息,订单支付成功后返回。

属性

 total_amount  必填   integer

【标价金额】商品单金额,单位为分,整型。


 payer_amount  必填   integer

【用户支付金额】用户支付金额,整型,单位为分。
用户支付金额 = 标价金额total_amount - 代金券金额promotion_detail.amount


 currency  必填   string(16)

【标价币种】下单时传入的标价币种。


 payer_currency  选填   string(16)

【用户支付币种】 用户实际支付的币种,符合ISO 4217标准的三位字母代码。例如:CNY,代表人民币。


 settlement_rate  选填   integer

【结算汇率】 结算汇率,即标价币种和结算币种的汇率,例如,美元(USD)与人民币(CNY)之间的汇率为6.5,则汇率值为650000000(汇率值是汇率乘以10的8次方),标价币种和子商户号的结算币种不一致时才返回。


 transaction_id  选填   string(32)

【商品单微信支付订单号】微信支付侧为每个商品单分配的唯一标识,订单支付成功后返回。


 out_trade_no  必填   string(32)

【商品单商户订单号】合单下单时传入的商品单商户订单号。


 sub_mchid  必填   string(32)

【子商户号(也叫特约商户号)】 合单下单时传入的子商户号。


 sub_appid  选填   string(32)

【子商户APPID】  合单下单时传入的子商户APPID,sub_mchid绑定的sub_appid。


 sub_openid  选填   string(128)

【用户子商户标识】下单时传入了sub_appid且支付成功后返回。


 promotion_detail  选填   array[object]

【优惠功能】 代金券信息,当订单支付时,有使用代金券时,该字段将返回所使用的代金券信息。

属性

 coupon_id  必填   string(32)

【券ID】 代金券id,微信为代金券分配的唯一标识,创券商户调用发放指定批次的代金券时返回的代金券ID coupon_id。


 name  选填   string(64)

【优惠名称】 优惠名称,创券商户创建代金券批次时传入的批次名称stock_name。


 scope  选填   string(32)

【优惠范围】优惠活动中代金券的适用范围,分为两种类型:
1、GLOBAL:全场代金券-以订单整体可优惠的金额为优惠门槛的代金券;
2、SINGLE:单品优惠-以订单中具体某个单品的总金额为优惠门槛的代金券


 type  选填   string(32)

【优惠类型】代金券资金类型,优惠活动中代金券的结算资金类型,分为两种类型:
1、CASH:预充值-带有结算资金的代金券,会随订单结算给订单收款商户;
2、NOCASH:免充值-不带有结算资金的代金券,无资金结算给订单收款商户。


 amount  必填   integer

【优惠券面额】当前商品单享受的代金券优惠金额。


 stock_id  选填   string(32)

【活动ID】单张代金券所对应的批次号。


 wechatpay_contribute  选填   integer

【微信出资】 代金券有三种出资类型:微信出资、商户出资和其他出资。本参数将返回选择“微信出资类型”时的优惠券面额。
1、创建代金券后默认为商户出资类型。如需使用其他两种类型,请与相关行业运营进行沟通。
2、在 wechatpay_contribute、merchant_contribute 和 other_contribute 这三个字段中,仅有一个字段会返回出资金额。具体返回哪个字段取决于代金券批次的配置。


 merchant_contribute  选填   integer

【商户出资】代金券有三种出资类型:微信出资、商户出资和其他出资。本参数将返回选择“商户出资类型”时的优惠券面额。
1、创建代金券后默认为商户出资类型。如需使用其他两种类型,请与相关行业运营进行沟通。
2、在 wechatpay_contribute、merchant_contribute 和 other_contribute 这三个字段中,仅有一个字段会返回出资金额。具体返回哪个字段取决于代金券批次的配置。


 other_contribute  选填   integer

【其他出资】代金券有三种出资类型:微信出资、商户出资和其他出资。本参数将返回选择“其他出资类型”时的优惠券面额。
1、创建代金券后默认为商户出资类型。如需使用其他两种类型,请与相关行业运营进行沟通。
2、在 wechatpay_contribute、merchant_contribute 和 other_contribute 这三个字段中,仅有一个字段会返回出资金额。具体返回哪个字段取决于代金券批次的配置。


 currency  选填   string(16)

【优惠币种】 代金券金额所对应的货币种类:固定返回:CNY,代表人民币。


goods_detail  选填   array[object]

【单品列表】 单品列表。scopeSINGLE(单品优惠)时返回该参数

属性

 goods_id  必填   string(32)

【商品编码】 商品编码。


 quantity  必填   integer

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


 unit_price  必填   integer

【商品单价】 商品单价,单位为分。


 discount_amount  必填   integer

【商品优惠金额】 商品优惠金额。


 goods_remark  选填   string(128)

【商品备注】 商品备注。创券商户在商户平台/服务商平台创建单品券时,若设置了商品备注则会返回。


scene_info  选填   object

【场景信息】下单时传入的支付场景描述,若下单传入该参数,则原样返回;若下单未传该参数,则不会返回。

属性

 device_id  选填   string(32)

【商户端设备号】 终端设备号(门店号或收银设备ID)


 combine_out_trade_no  必填   string(32)

【合单商户订单号】 合单下单时传入的合单商户订单号。

应答示例

200 OK

1{
2  "combine_appid" : "wxd678efh567hg6787",
3  "combine_mchid" : "1230000109",
4  "combine_out_trade_no" : "P20150806125346",
5  "combine_payer_info" : {
6    "openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"
7  },
8  "scene_info" : {
9    "device_id" : "POS1:1"
10  },
11  "sub_orders" : [
12    {
13      "mchid" : "1900000109",
14      "sub_mchid" : "1230000109",
15      "sub_appid" : "wxd678efh567hg6999",
16      "sub_openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
17      "out_trade_no" : "20150806125346",
18      "transaction_id" : "1009660380201506130728806387",
19      "trade_type" : "JSAPI",
20      "trade_state" : "SUCCESS",
21      "bank_type" : "CMC",
22      "attach" : "深圳分店",
23      "success_time" : "2015-05-20T13:29:35.120+08:00",
24      "amount" : {
25        "total_amount" : 10,
26        "payer_amount" : 10,
27        "currency" : "CNY",
28        "payer_currency" : "CNY",
29        "settlement_rate" : 650000000
30      },
31      "promotion_detail" : [
32        {
33          "coupon_id" : "109519",
34          "name" : "单品惠-6",
35          "scope" : "GLOBAL",
36          "type" : "CASH",
37          "amount" : 100,
38          "stock_id" : "931386",
39          "wechatpay_contribute" : 0,
40          "merchant_contribute" : 0,
41          "other_contribute" : 0,
42          "currency" : "CNY",
43          "goods_detail" : [
44            {
45              "goods_id" : "M1006",
46              "quantity" : 1,
47              "unit_price" : 100,
48              "discount_amount" : 1,
49              "goods_remark" : "商品备注信息"
50            }
51          ]
52        }
53      ]
54    }
55  ]
56}
57

 

错误码

公共错误码

状态码

错误码

描述

解决方案

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是否匹配,参考:查询商户号绑定的APPID

400

INVALID_REQUEST

无效请求

请根据接口返回的详细信息检查

400

MCH_NOT_EXISTS

商户号不存在

请检查商户号是否正确,商户号获取方法参考:服务商模式开发必要参数说明

400

ORDER_CLOSED

订单已关闭

当前订单已关闭,请重新下单

401

SIGN_ERROR

签名错误

请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名

403

NOAUTH

商户无权限

请商户联系对接运营申请此接口相关权限,参考:权限申请

403

OUT_TRADE_NO_USED

商户订单号重复

请核实商户订单号是否重复提交

403

RULELIMIT

业务规则限制

因业务规则限制请求频率,请查看接口返回的详细信息

429

FREQUENCY_LIMITED

频率超限

请降低请求接口频率

500

SYSTEMERROR

系统错误

系统异常,请用相同参数重新调用

 

 

元宝AI
反馈
目录
置顶