查詢訂單
應(yīng)用場景
該接口提供所有微信支付訂單的查詢,商戶可以通過查詢訂單接口主動查詢訂單狀態(tài),完成下一步的業(yè)務(wù)邏輯。
需要調(diào)用查詢接口的情況:
- ◆ 當(dāng)商戶后臺、網(wǎng)絡(luò)、服務(wù)器等出現(xiàn)異常,商戶系統(tǒng)最終未接收到支付通知(查單實(shí)現(xiàn)可參考:支付回調(diào)和查單實(shí)現(xiàn)指引);
- ◆ 調(diào)用支付接口后,返回系統(tǒng)錯誤或未知交易狀態(tài)情況;
- ◆ 調(diào)用付款碼支付API,返回USERPAYING的狀態(tài);
- ◆ 調(diào)用關(guān)單或撤銷接口API之前,需確認(rèn)支付狀態(tài);
接口鏈接
URL地址:https://api.mch.weixin.qq.com/pay/orderquery
URL地址:https://api2.mch.weixin.qq.com/pay/orderquery(備用域名)見跨城冗災(zāi)方案
是否需要證書
不需要
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公眾賬號ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信支付分配的公眾賬號ID(企業(yè)號corpid即為此appid) |
商戶號 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商戶號 |
微信訂單號 | transaction_id | 二選一 | String(32) | 1009660380201506130728806387 | 微信的訂單號,建議優(yōu)先使用 |
商戶訂單號 | out_trade_no | String(32) | 20150806125346 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi)(最少6個字符),只能是數(shù)字、大小寫字母_-|*且在同一個商戶號下唯一。詳見商戶訂單號 | |
隨機(jī)字符串 | nonce_str | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 隨機(jī)字符串,不長于32位。推薦隨機(jī)數(shù)生成算法 |
簽名 | sign | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 通過簽名算法計(jì)算得出的簽名值,詳見簽名生成算法 |
簽名類型 | sign_type | 否 | String(32) | HMAC-SHA256 | 簽名類型,目前支持HMAC-SHA256和MD5,默認(rèn)為MD5 |
舉例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
<transaction_id>1008450740201411110005820873</transaction_id>
<sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
</xml>
返回結(jié)果
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信標(biāo)識,非交易標(biāo)識,交易是否成功需要查看trade_state來判斷 |
返回信息 | return_msg | 是 | String(128) | OK |
當(dāng)return_code為FAIL時返回信息為錯誤原因 ,例如 簽名失敗 參數(shù)格式校驗(yàn)錯誤 |
以下字段在return_code為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公眾賬號ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信分配的公眾賬號ID |
商戶號 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商戶號 |
隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串,不長于32位。推薦隨機(jī)數(shù)生成算法 |
簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名,詳見簽名生成算法 |
業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
錯誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 當(dāng)result_code為FAIL時返回錯誤代碼,詳細(xì)參見下文錯誤列表 |
錯誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)錯誤 | 當(dāng)result_code為FAIL時返回錯誤描述,詳細(xì)參見下文錯誤列表 |
以下字段在return_code 、result_code、trade_state都為SUCCESS時有返回 。
交易成功判斷條件: return_code、result_code和trade_state都為SUCCESS
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
設(shè)備號 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的終端設(shè)備號 |
用戶標(biāo)識 | openid | 是 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | 用戶在商戶appid下的唯一標(biāo)識 |
是否關(guān)注公眾賬號 | is_subscribe | 是 | String(1) | N | 已廢棄,默認(rèn)統(tǒng)一返回N |
交易類型 | trade_type | 是 | String(16) | JSAPI | 調(diào)用接口提交的交易類型,取值如下:JSAPI,NATIVE,APP,MICROPAY,詳細(xì)說明見參數(shù)規(guī)定 |
交易狀態(tài) | trade_state | 是 | String(32) | SUCCESS | SUCCESS--支付成功 REFUND--轉(zhuǎn)入退款 NOTPAY--未支付 CLOSED--已關(guān)閉 REVOKED--已撤銷(刷卡支付) USERPAYING--用戶支付中 PAYERROR--支付失敗(其他原因,如銀行返回失敗) ACCEPT--已接收,等待扣款 支付狀態(tài)機(jī)請見下單API頁面 |
付款銀行 | bank_type | 是 | String(32) | CMC | 銀行類型,采用字符串類型的銀行標(biāo)識 |
標(biāo)價(jià)金額 | total_fee | 是 | int | 100 | 訂單總金額,單位為分 |
應(yīng)結(jié)訂單金額 | settlement_total_fee | 否 | int | 100 | 當(dāng)訂單使用了免充值型優(yōu)惠券后返回該參數(shù),應(yīng)結(jié)訂單金額=訂單金額-免充值優(yōu)惠券金額。 |
標(biāo)價(jià)幣種 | fee_type | 否 | String(8) | CNY | 貨幣類型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見貨幣類型 |
現(xiàn)金支付金額 | cash_fee | 是 | int | 100 | 現(xiàn)金支付金額訂單現(xiàn)金支付金額,詳見支付金額 |
現(xiàn)金支付幣種 | cash_fee_type | 否 | String(16) | CNY | 貨幣類型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見貨幣類型 |
代金券金額 | coupon_fee | 否 | int | 100 | “代金券”金額<=訂單金額,訂單金額-“代金券”金額=現(xiàn)金支付金額,詳見支付金額 |
代金券使用數(shù)量 | coupon_count | 否 | int | 1 | 代金券使用數(shù)量 |
代金券類型 | coupon_type_$n | 否 | String | CASH | CASH:充值代金券 NO_CASH:非充值優(yōu)惠券 開通免充值券功能,并且訂單使用了優(yōu)惠券后有返回(取值:CASH、NO_CASH)。$n為下標(biāo),從0開始編號,舉例:coupon_type_$0 |
代金券ID | coupon_id_$n | 否 | String(20) | 10000 | 代金券ID, $n為下標(biāo),從0開始編號 |
單個代金券支付金額 | coupon_fee_$n | 否 | int | 100 | 單個代金券支付金額, $n為下標(biāo),從0開始編號 |
微信支付訂單號 | transaction_id | 是 | String(32) | 1009660380201506130728806387 | 微信支付訂單號 |
商戶訂單號 | out_trade_no | 是 | String(32) | 20150806125346 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi)(最少6個字符),只能是數(shù)字、大小寫字母_-|*且在同一個商戶號下唯一。詳見商戶訂單號 |
附加數(shù)據(jù) | attach | 否 | String(128) | 深圳分店 | 附加數(shù)據(jù),原樣返回 |
支付完成時間 | time_end | 是 | String(14) | 20141030133525 | 訂單支付時間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見時間規(guī)則 |
交易狀態(tài)描述 | trade_state_desc | 是 | String(256) | 支付失敗,請重新下單支付 | 對當(dāng)前查詢訂單狀態(tài)的描述和下一步操作的指引 |
舉例如下:
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<device_info><![CDATA[1000]]></device_info>
<nonce_str><![CDATA[TN55wO9Pba5yENl8]]></nonce_str>
<sign><![CDATA[BDF0099C15FF7BC6B1585FBB110AB635]]></sign>
<result_code><![CDATA[SUCCESS]]></result_code>
<openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid>
<is_subscribe><![CDATA[N]]></is_subscribe>
<trade_type><![CDATA[MICROPAY]]></trade_type>
<bank_type><![CDATA[CCB_DEBIT]]></bank_type>
<total_fee>1</total_fee>
<fee_type><![CDATA[CNY]]></fee_type>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
<out_trade_no><![CDATA[1415757673]]></out_trade_no>
<attach><![CDATA[訂單額外描述]]></attach>
<time_end><![CDATA[20141111170043]]></time_end>
<trade_state><![CDATA[SUCCESS]]></trade_state>
</xml>
錯誤碼
名稱 | 描述 | 原因 | 解決方案 |
---|---|---|---|
ORDERNOTEXIST | 此交易訂單號不存在 | 查詢系統(tǒng)中不存在此交易訂單號 | 該API只能查提交支付交易返回成功的訂單,請商戶檢查需要查詢的訂單號是否正確 |
SYSTEMERROR | 系統(tǒng)錯誤 | 后臺系統(tǒng)返回錯誤 | 系統(tǒng)異常,請?jiān)僬{(diào)用發(fā)起查詢 |