最新更新時(shí)間:2020.5.08 版本說明
該接口提供所有微信支付訂單的查詢,商戶可以通過該接口主動(dòng)查詢訂單狀態(tài),完成下一步的業(yè)務(wù)邏輯。
需要調(diào)用查詢接口的情況:
● 當(dāng)商戶后臺(tái)、網(wǎng)絡(luò)、服務(wù)器等出現(xiàn)異常,商戶系統(tǒng)最終未接收到支付通知;
● 調(diào)用支付接口后,返回系統(tǒng)錯(cuò)誤或未知交易狀態(tài)情況;
● 調(diào)用刷卡支付API,返回USERPAYING的狀態(tài);
● 調(diào)用關(guān)單或撤銷接口API之前,需確認(rèn)支付狀態(tài);
適用對(duì)象:直連模式機(jī)構(gòu)模式
請(qǐng)求URL:
https://api.mch.weixin.qq.com/pay/orderquery
請(qǐng)求方式: POST
數(shù)據(jù)格式: XML
是否需要證書: 否
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
公眾賬號(hào)ID | appid | string(32) | 是 | 微信分配的公眾賬號(hào)ID 示例值:wxd678efh567hg6787 |
子商戶公眾賬號(hào)ID | sub_appid | string(32) | 否 | 微信分配的子商戶公眾賬號(hào)ID 注意:僅適用于機(jī)構(gòu)模式 示例值:wx8888888888888888 |
商戶號(hào) | mchid | string(32) | 是 | 微信支付分配的商戶號(hào) 示例值:1900000109 |
子商戶號(hào) | sub_mchid | string(32) | 是 | 微信支付分配的子商戶號(hào) 注意:僅適用于機(jī)構(gòu)模式 示例值:1900000109 |
微信支付訂單號(hào) | transaction_id | string(32) | 二選一 | 微信的訂單號(hào),優(yōu)先使用 示例值:4200000000002104083200000488 |
商戶訂單號(hào) | out_trade_no | string(32) | 商戶系統(tǒng)內(nèi)部的訂單號(hào),當(dāng)沒提供transaction_id時(shí)需要傳這個(gè)。 示例值:20150806125346 |
|
隨機(jī)字符串 | nonce_str | string(32) | 是 | 隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
簽名 | sign | string(64) | 是 | 簽名,詳見簽名生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名類型 | sign_type | string(32) | 否 | 簽名類型,目前支持HMAC-SHA256和MD5,默認(rèn)為MD5 示例值:HMAC-SHA256 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>f6868b9b16bf4893958afd4a46d73422</nonce_str>
<out_trade_no>1678371718207317</out_trade_no>
<sign>6D3B28F0CA86C4756E40366D341BC395</sign>
<sub_mch_id>452532745</sub_mch_id>
</xml>
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string(16) | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識(shí),非交易標(biāo)識(shí),交易是否成功需要查看trade_state來判斷 示例值:SUCCESS |
返回信息 | return_msg | string(128) | 是 | 返回信息,如非空,為錯(cuò)誤原因,簽名失敗,參數(shù)格式校驗(yàn)錯(cuò)誤 示例值:簽名失敗 |
以下字段在return_code為SUCCESS的時(shí)候有返回
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
公眾賬號(hào)ID | appid | string(32) | 是 | 微信分配的公眾賬號(hào)ID 示例值:wxd678efh567hg6787 |
商戶號(hào) | mch_id | string(32) | 是 | 微信支付分配的商戶號(hào) 示例值:1900000109 |
子商戶公眾賬號(hào)ID | sub_appid | string(32) | 是 | 微信分配的子商戶公眾賬號(hào)ID 注意:僅適用于機(jī)構(gòu)模式 示例值:wx8888888888888888 |
子商戶號(hào) | sub_mch_id | string(32) | 是 | 微信支付分配的子商戶號(hào) 注意:僅適用于機(jī)構(gòu)模式 示例值:1900000109 |
隨機(jī)字符串 | nonce_str | string(32) | 是 | 隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string(64) | 是 | 簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
業(yè)務(wù)結(jié)果 | result_code | string(16) | 是 | SUCCESS/FAIL 示例值:SUCCESS |
錯(cuò)誤代碼 | err_code | string(32) | 否 | 詳細(xì)參見錯(cuò)誤列表 示例值:SYSTEMERROR |
錯(cuò)誤代碼描述 | err_code_des | string(128) | 否 | 結(jié)果信息描述 示例值:系統(tǒng)錯(cuò)誤 |
以下字段在return_code 、result_code、trade_state都為SUCCESS時(shí)有返回 ,如trade_state不為 SUCCESS,則只返回out_trade_no(必傳)和attach(選傳)。
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
設(shè)備號(hào) | device_info | string(32) | 否 | 微信支付分配的終端設(shè)備號(hào) 示例值:013467007045764 |
用戶標(biāo)識(shí) | openid | string(128) | 是 | 用戶在商戶appid下的唯一標(biāo)識(shí) 示例值:wxd930ea5d5a258f4f |
是否關(guān)注公眾賬號(hào) | is_subscribe | string(1) | 是 | 用戶是否關(guān)注公眾賬號(hào),Y-關(guān)注,N-未關(guān)注(機(jī)構(gòu)商戶不返回) 示例值:Y |
用戶子標(biāo)識(shí) | sub_openid | string(128) | 否 | 用戶在子商戶appid下的唯一標(biāo)識(shí) 注意:僅適用于機(jī)構(gòu)模式 示例值:wxd930ea5d5a258f4f |
是否關(guān)注子公眾賬號(hào) | sub_is_subscribe | string(1) | 否 | 用戶是否關(guān)注子公眾賬號(hào),Y-關(guān)注,N-未關(guān)注(機(jī)構(gòu)商戶不返回) 注意:僅適用于機(jī)構(gòu)模式 示例值:Y |
交易類型 | trade_type | string(16) | 是 | 調(diào)用接口提交的交易類型,取值如下:JSAPI,NATIVE,APP,MICROPAY,詳細(xì)說明見參數(shù)規(guī)定 示例值:JSAPI |
交易狀態(tài) | trade_state | string(32) | 是 |
SUCCESS—支付成功 REFUND—轉(zhuǎn)入退款 NOTPAY—未支付 CLOSED—已關(guān)閉 REVOKED—已撤銷(刷卡支付) USERPAYING--用戶支付中 PAYERROR--支付失敗(其他原因,如銀行返回失敗) 示例值:SUCCESS |
付款銀行 | bank_type | string(32) | 是 | 銀行類型,采用字符串類型的銀行標(biāo)識(shí) 示例值:CMC |
標(biāo)價(jià)金額 | total_fee | int | 是 | 標(biāo)價(jià)金額,單位為該幣種最小計(jì)算單位,只能為整數(shù),詳見標(biāo)價(jià)金額 示例值:888 |
標(biāo)價(jià)幣種 | fee_type | string(8) | 是 | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,詳見標(biāo)價(jià)幣種 示例值:GBP |
用戶支付金額 | cash_fee | int | 是 | 訂單現(xiàn)金支付金額,詳見支付金額 示例值:100 |
現(xiàn)金支付貨幣類型 | cash_fee_type | string(16) | 否 | 貨幣類型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,列表詳見貨幣類型 示例值:USD |
微信支付訂單號(hào) | transaction_id | string(32) | 是 | 微信支付訂單號(hào) 示例值:4200000000002104083200000488 |
商戶訂單號(hào) | out_trade_no | string(32) | 是 | 商戶系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個(gè)商戶號(hào)下唯一。 示例值:20150806125346 |
附加數(shù)據(jù) | attach | string(128) | 否 | 附加數(shù)據(jù),原樣返回 示例值:深圳分店 |
支付完成時(shí)間 | time_end | string(14) | 是 | 訂單支付時(shí)間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見時(shí)間規(guī)則 示例值:20141030133525 |
匯率 | rate | string(16) | 是 | 標(biāo)價(jià)幣種與支付幣種的兌換比例乘以10的8次方即為此值,例如美元兌換人民幣的比例為6.5,則rate=650000000 示例值:650000000 |
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<result_code><![CDATA[SUCCESS]]></result_code>
<mch_id><![CDATA[10000100]]></mch_id>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<sub_mch_id><![CDATA[375907253]]></sub_mch_id>
<nonce_str><![CDATA[R2bkCd5bRJ8tBLN3]]></nonce_str>
<sign><![CDATA[A5B986A3FBB3609A182C7F38F7CEC02C]]></sign>
<openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid>
<is_subscribe><![CDATA[N]]></is_subscribe>
<trade_type><![CDATA[MICROPAY]]></trade_type>
<bank_type><![CDATA[OTHERS]]></bank_type>
<fee_type><![CDATA[CAD]]></fee_type>
<total_fee>2238</total_fee>
<cash_fee_type><![CDATA[CNY]]></cash_fee_type>
<cash_fee>11560</cash_fee>
<transaction_id><![CDATA[4200001137204318031621608237]]></transaction_id>
<out_trade_no><![CDATA[NO20211012215248466958150050]]></out_trade_no>
<attach><![CDATA[]]></attach>
<time_end><![CDATA[20211105230556]]></time_end>
<rate><![CDATA[516532998]]></rate>
</xml>
錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|
ORDERNOTEXIST | 此交易訂單號(hào)不存在 | 該API只能查提交支付交易返回成功的訂單,請(qǐng)商戶檢查需要查詢的訂單號(hào)是否正確 |
SYSTEMERROR | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常,請(qǐng)?jiān)僬{(diào)用發(fā)起查詢 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證