最新更新时间:2020.1.08 版本说明
该接口提供所有微信支付订单的查询,商户可以通过查询订单接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
● 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
● 调用支付接口后,返回系统错误或未知交易状态情况;
● 调用刷卡支付API,返回USERPAYING的状态;
● 调用刷卡支付API,返回USERPAYING的状态;
适用对象:直连模式机构模式
请求URL: https://api.mch.weixin.qq.com/hk/v3/transactions/id/{id}
或
https://api.mch.weixin.qq.com/hk/v3/transactions/out-trade-no/{out_trade_no}
请求方式: GET
接口规则: https://wechatpay-api.gitbook.io/wechatpay-api-v3/wei-xin-zhi-fu-api-v3-jie-kou-gui-fan
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
商户号 | mchid | string(32) | 是 | query 微信支付分配的商户号 注意:仅适用于直连模式 示例值:1900000109 |
子商户号 | sub_mchid | string(32) | 是 | query 微信支付分配的子商户号 注意:仅适用于机构模式 示例值:1900000109 |
机构商户号 | sp_mchid | string(32) | 是 | query 微信支付分配的机构商户号 注意:仅适用于机构模式 示例值:1900000100 |
商户订单号 | out_trade_no | string(32) | 二选一 | path返回的商户订单号 示例值:1217752501201407033233368018 |
微信支付订单号 | id | string(32) | path微信支付订单号 示例值:4200000000002104083200000488 |
使用微信支付订单号查单示例:
https://api.mch.weixin.qq.com/hk/v3/transactions/id/4200000000002104083200000488?mchid=1900000109
使用商户订单号查单示例:
https://api.mch.weixin.qq.com/hk/v3/transactions/out-trade-no/1217752501201407033233368018?sub_mchid =1900000109&sp_mchid =1900000100
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
商户号 | mchid | string(32) | 是 | 微信支付分配的商户号 注意:仅适用于直连模式 示例值:1900000109 |
APPID | appid | string(32) | 是 | 商户在微信公众平台申请服务号对应的APPID 注意:仅适用于直连模式 示例值:wx8888888888888888 |
机构商户号 | sp_mchid | string(32) | 是 | 微信支付分配的机构商户号 注意:仅适用于机构模式 示例值:1900000100 |
子商户号 | sub_mchid | string(32) | 是 | 微信支付分配的子商户号 注意:仅适用于机构模式 示例值:1900000109 |
机构APPID | sp_appid | string(32) | 是 | 机构在微信公众平台申请服务号对应的APPID 注意:仅适用于机构模式 示例值:wx8888888888888888 |
子商户APPID | sub_appid | string(32) | 否 | 子商户在微信开放平台申请移动应用对应的APPID 注意:仅适用于机构模式 示例值:wx8888888888888888 |
商户订单号 | out_trade_no | string(32) | 是 | 返回的商户订单号 示例值:1217752501201407033233368018 |
微信支付订单号 | id | string(32) | 是 | 微信支付订单号 示例值:4200000000002104083200000488 |
商户数据 | attach | string(127) | 否 | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 示例值:自定义数据 |
交易类型 | trade_type | string(16) | 是 | APP支付 示例值:APP |
付款银行 | bank_type | string(32) | 是 | 银行类型,采用字符串类型的银行标识,值列表详见银行类型 示例值:CMC |
支付完成时间 | success_time | string(64) | 是 | 订单支付成功时间,格式为rfc3339格式,如2018-06-08T10:34:56+08:00 代表北京时间2018年06月08日10时34分56秒 示例值:2018-06-08T10:34:56+08:00 |
交易状态 | trade_state | string(32) | 是 | SUCCESS—支付成功 REFUND—转入退款 NOTPAY—未支付 CLOSED—已关闭 REVOKED—已撤销(刷卡支付) USERPAYING--用户支付中 PAYERROR--支付失败(其他原因,如银行返回失败) 示例值:SUCCESS |
交易状态描述 | trade_state_desc | string(256) | 是 | 对当前订单状态的描述和下一步操作的指引 示例值:支付失败,请重新下单支付 |
+支付者 | payer | object | 是 | 支付者信息,详细说明见下文 |
+ 订单金额 | amount | object | 是 | 订单金额信息,详细说明见下文 |
+ 优惠功能 | promotion_detail | array | 否 | 优惠功能信息,详细说明见下文 |
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | code | string(32) | 是 | 错误码,枚举值见错误码列表 示例值:INVALID_REQUEST |
返回信息 | message | string(256) | 是 | 返回信息,如非空,为错误原因 示例值:参数格式校验错误 |
+ 详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 |
{
"id": "4200000000002104083200000488",
"sp_appid": "wx2421b1c4370ec43b",
"sp_mchid": "10000100",
"sub_mchid": "20000100",
"out_trade_no": "20150806125346",
"payer": {
"sp_openid": "oUpF8uN95-Ptaags6E_roPHg7AG0"
},
"amount" : {
"total": 528800,
"currency": "HKD",
"payer_total": 518799,
"payer_currency": "CNY",
"exchange_rate" : {
"type": "SETTLEMENT_RATE",
"rate": 8000000
}
},
"trade_type": "APP",
"trade_state": "SUCCESS",
"trade_state_desc": "支付成功",
"bank_type": "CCB_DEBIT",
"attach": "支付测试",
"success_time": "2018-06-08T10:34:56+08:00",
"promotion_detail":[
{
"promotion_id":"109519",
"name":"单品惠-6",
"scope":"SINGLE",
"type":"DISCOUNT",
"amount":1,
"currency":"HKD",
"activity_id":"931386",
"wechatpay_contribute_amount":1,
"merchant_contribute_amount":0,
"other_contribute_amount":0,
"goods_detail":[
{
"goods_id":"iphone6s_16G",
"goods_remark":"商品备注",
"quantity":1,
"price":528800
}
]
}
]
}
错误码 | 描述 | 解决方案 |
---|---|---|
ORDER_NOT_EXIST | 此交易订单号不存在 | 该API只能查提交支付交易返回成功的订单,请商户检查需要查询的订单号是否正确 |
SYSTEMERROR | 系统错误 | 系统异常,请再调用发起查询 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证