最新更新時間:2020.1.08 版本說明
該接口提供所有微信支付訂單的查詢,商戶可以通過查詢訂單接口主動查詢訂單狀態(tài),完成下一步的業(yè)務邏輯。
需要調(diào)用查詢接口的情況:
● 當商戶后臺、網(wǎng)絡、服務器等出現(xiàn)異常,商戶系統(tǒng)最終未接收到支付通知;
● 調(diào)用支付接口后,返回系統(tǒng)錯誤或未知交易狀態(tài)情況;
● 調(diào)用刷卡支付API,返回USERPAYING的狀態(tài);
● 調(diào)用刷卡支付API,返回USERPAYING的狀態(tài);
適用對象:直連模式機構(gòu)模式
請求URL: https://api.mch.weixin.qq.com/hk/v3/transactions/transaction_id/{transaction_id}
或
https://api.mch.weixin.qq.com/hk/v3/transactions/out-trade-no/{out_trade_no}
請求方式: GET
接口規(guī)則: https://wechatpay-api.gitbook.io/wechatpay-api-v3
path 指該參數(shù)需在請求URL傳參
query 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
商戶號 | mchid | string(32) | 是 | path 微信支付分配的商戶號 注意:僅適用于直連模式 示例值:1900000109 |
子商戶號 | sub_mchid | string(32) | 是 | path 微信支付分配的子商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000109 |
機構(gòu)商戶號 | sp_mchid | string(32) | 是 | path 微信支付分配的機構(gòu)商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000100 |
商戶訂單號 | out_trade_no | string(32) | 二選一 | path返回的商戶訂單號 示例值:1217752501201407033233368018 |
微信支付訂單號 | transaction_id | string(32) | path微信支付訂單號 示例值:1217752501201407033233368018 |
使用微信支付訂單號查單示例:
https://api.mch.weixin.qq.com/hk/v3/transactions/transaction_id/1217752501201407033233368018?mchid=1900000109
使用商戶訂單號查單示例:
https://api.mch.weixin.qq.com/hk/v3/transactions/out-trade-no/1217752501201407033233368018?sub_mchid =1900000109&sp_mchid =1900000100
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
商戶號 | mchid | string(32) | 是 | 微信支付分配的商戶號 注意:僅適用于直連模式 示例值:1900000109 |
APPID | appid | string(32) | 是 | 商戶在微信公眾平臺申請服務號對應的APPID 注意:僅適用于直連模式 示例值:wx8888888888888888 |
機構(gòu)商戶號 | sp_mchid | string(32) | 是 | 微信支付分配的機構(gòu)商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000100 |
子商戶號 | sub_mchid | string(32) | 是 | 微信支付分配的子商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000109 |
機構(gòu)APPID | sp_appid | string(32) | 是 | 機構(gòu)在微信公眾平臺申請服務號對應的APPID 注意:僅適用于機構(gòu)模式 示例值:wx8888888888888888 |
子商戶APPID | sub_appid | string(32) | 否 | 子商戶在微信開放平臺申請移動應用對應的APPID 注意:僅適用于機構(gòu)模式 示例值:wx8888888888888888 |
商戶訂單號 | out_trade_no | string(32) | 是 | 返回的商戶訂單號 示例值:1217752501201407033233368018 |
微信支付訂單號 | transaction_id | string(32) | 是 | 微信支付訂單號 示例值:1217752501201407033233368018 |
商戶數(shù)據(jù) | attach | string(127) | 否 | 附加數(shù)據(jù),在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù) 示例值:自定義數(shù)據(jù) |
交易類型 | trade_type | string(16) | 是 | APP支付 示例值:APP |
付款銀行 | bank_type | string(16) | 是 | 銀行類型,采用字符串類型的銀行標識,值列表詳見銀行類型 示例值: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 |
交易狀態(tài) | trade_state | string(32) | 是 | SUCCESS—支付成功 REFUND—轉(zhuǎn)入退款 NOTPAY—未支付 CLOSED—已關(guān)閉 REVOKED—已撤銷(刷卡支付) USERPAYING--用戶支付中 PAYERROR--支付失敗(其他原因,如銀行返回失敗) 示例值:SUCCESS |
交易狀態(tài)描述 | trade_state_desc | string(256) | 是 | 對當前訂單狀態(tài)的描述和下一步操作的指引 示例值:支付失敗,請重新下單支付 |
+支付者 | payer | object | 是 | 支付者信息,詳細說明見下文 |
+ 訂單金額 | amount | object | 是 | 訂單金額信息,詳細說明見下文 |
+ 優(yōu)惠功能 | promotion_detail | array | 否 | 優(yōu)惠功能信息,詳細說明見下文 |
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | code | string(32) | 是 | 錯誤碼,枚舉值見錯誤碼列表 示例值:INVALID_REQUEST |
返回信息 | message | string(256) | 是 | 返回信息,如非空,為錯誤原因 示例值:參數(shù)格式校驗錯誤 |
+ 詳細的錯誤描述 | detail | object | 否 | 當code為PARAM_ERROR時返回,詳細說明見下 |
{
"transaction_id": "1008450740201411110005820873",
"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
}
]
}
]
}
錯誤碼 | 描述 | 解決方案 |
---|---|---|
ORDERNOTEXIST | 此交易訂單號不存在 | 該API只能查提交支付交易返回成功的訂單,請商戶檢查需要查詢的訂單號是否正確 |
SYSTEMERROR | 系統(tǒng)錯誤 | 系統(tǒng)異常,請再調(diào)用發(fā)起查詢 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證