查詢(xún)訂單
應(yīng)用場(chǎng)景
該接口提供所有微信支付訂單的查詢(xún),商戶(hù)可以通過(guò)該接口主動(dòng)查詢(xún)訂單狀態(tài),完成下一步的業(yè)務(wù)邏輯。
需要調(diào)用查詢(xún)接口的情況:
- ◆ 當(dāng)商戶(hù)后臺(tái)、網(wǎng)絡(luò)、服務(wù)器等出現(xiàn)異常,商戶(hù)系統(tǒng)最終未接收到支付通知(查單實(shí)現(xiàn)可參考:支付回調(diào)和查單實(shí)現(xiàn)指引);
- ◆ 調(diào)用支付接口后,返回系統(tǒng)錯(cuò)誤或未知交易狀態(tài)情況;
- ◆ 調(diào)用被掃支付API,返回USERPAYING的狀態(tài);
- ◆ 調(diào)用關(guān)單或撤銷(xiāo)接口API之前,需確認(rèn)支付狀態(tài);
接口鏈接
https://api.mch.weixin.qq.com/pay/orderquery
是否需要證書(shū)
不需要
請(qǐng)求參數(shù)
字段名 | 變量名 | 必填 | 類(lèi)型 | 示例值 | 描述 |
---|---|---|---|---|---|
服務(wù)商的APPID | appid | 是 | String(32) | wx8888888888888888 | 服務(wù)商商戶(hù)的APPID |
子商戶(hù)公眾賬號(hào)ID | sub_appid | 否 | String(32) | wx8888888888888888 | 微信分配的子商戶(hù)公眾賬號(hào)ID |
商戶(hù)號(hào) | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶(hù)號(hào) |
子商戶(hù)號(hào) | sub_mch_id | 是 | String(32) | 1900000109 | 微信支付分配的子商戶(hù)號(hào) |
微信訂單號(hào) | transaction_id | 二選一 | String(32) | 013467007045764 | 微信的訂單號(hào),優(yōu)先使用 |
商戶(hù)訂單號(hào) | out_trade_no | String(32) | 1217752501201407033233368018 | 商戶(hù)系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi)(最少6個(gè)字符),只能是數(shù)字、大小寫(xiě)字母_-|*且在同一個(gè)商戶(hù)號(hào)下唯一。詳見(jiàn)商戶(hù)訂單號(hào) | |
隨機(jī)字符串 | nonce_str | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 |
簽名 | sign | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 簽名,詳見(jiàn)簽名生成算法 |
舉例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<sub_appid>wx2421b1c4370ec43b</sub_appid>
<mch_id>10000100</mch_id>
<sub_mch_id>1900000109</sub_mch_id>
<nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
<transaction_id>1008450740201411110005820873</transaction_id>
<sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
</xml>
返回結(jié)果
字段名 | 變量名 | 必填 | 類(lèi)型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信標(biāo)識(shí),非交易標(biāo)識(shí),交易是否成功需要查看trade_state來(lái)判斷 |
返回信息 | return_msg | 否 | String(128) | 簽名失敗 |
返回信息,如非空,為錯(cuò)誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 |
以下字段在return_code為SUCCESS的時(shí)候有返回
字段名 | 變量名 | 必填 | 類(lèi)型 | 示例值 | 描述 |
---|---|---|---|---|---|
服務(wù)商的APPID | appid | 是 | String(32) | wx8888888888888888 | 服務(wù)商商戶(hù)的APPID |
商戶(hù)號(hào) | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶(hù)號(hào) |
子商戶(hù)公眾賬號(hào)ID | sub_appid | 否 | String(32) | wx8888888888888888 | 微信分配的子商戶(hù)公眾賬號(hào)ID |
子商戶(hù)號(hào) | sub_mch_id | 是 | String(32) | 1900000109 | 微信支付分配的子商戶(hù)號(hào) |
隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 |
簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名,詳見(jiàn)簽名生成算法 |
業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
錯(cuò)誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 詳細(xì)參見(jiàn)第6節(jié)錯(cuò)誤列表 |
錯(cuò)誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)錯(cuò)誤 | 結(jié)果信息描述 |
以下字段在return_code 、result_code、trade_state都為SUCCESS時(shí)有返回 。
交易成功判斷條件: return_code、result_code和trade_state都為SUCCESS
字段名 | 變量名 | 必填 | 類(lèi)型 | 示例值 | 描述 |
---|---|---|---|---|---|
設(shè)備號(hào) | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的終端設(shè)備號(hào), |
用戶(hù)標(biāo)識(shí) | openid | 是 | String(128) | wxd930ea5d5a258f4f | 用戶(hù)在商戶(hù)appid下的唯一標(biāo)識(shí) |
是否關(guān)注公眾賬號(hào) | is_subscribe | 是 | String(1) | N | 已廢棄,默認(rèn)統(tǒng)一返回N |
用戶(hù)子標(biāo)識(shí) | sub_openid | 否 | String(128) | wxd930ea5d5a258f4f | 用戶(hù)在子商戶(hù)appid下的唯一標(biāo)識(shí) |
是否關(guān)注子公眾賬號(hào) | sub_is_subscribe | 否 | String(1) | N | 已廢棄,默認(rèn)統(tǒng)一返回N |
交易類(lèi)型 | trade_type | 是 | String(16) | JSAPI | 調(diào)用接口提交的交易類(lèi)型,取值如下:JSAPI,NATIVE,APP,MICROPAY,詳細(xì)說(shuō)明見(jiàn)參數(shù)規(guī)定 |
交易狀態(tài) | trade_state | 是 | String(32) | SUCCESS | SUCCESS--支付成功 REFUND--轉(zhuǎn)入退款 NOTPAY--未支付 CLOSED--已關(guān)閉 REVOKED--已撤銷(xiāo)(刷卡支付) USERPAYING--用戶(hù)支付中 PAYERROR--支付失敗(其他原因,如銀行返回失敗) ACCEPT--已接收,等待扣款 |
付款銀行 | bank_type | 是 | String(32) | CMC | 銀行類(lèi)型,采用字符串類(lèi)型的銀行標(biāo)識(shí) |
商品詳情 | detail | 否 | String(8192) | { "discount_detail":[ { "goods_id":"iphone6s_16G", "goods_name":"iPhone6s 16G", "coupon_batch_id":888, "coupon_id":666888, "coupon_fee":1000 }, { "goods_id":"iphone6s_32G", "goods_name":"iPhone6s 32G", "coupon_batch_id":999, "coupon_id":666999, "coupon_fee":1500 } ] } |
商品詳細(xì)列表,使用Json格式,傳輸簽名前請(qǐng)務(wù)必使用CDATA標(biāo)簽將JSON文本串保護(hù)起來(lái)。如果使用了單品優(yōu)惠,會(huì)有單品優(yōu)惠信息返回 discount_detail []: |
標(biāo)價(jià)金額 | total_fee | 是 | int | 100 | 訂單總金額,單位為分 |
標(biāo)價(jià)幣種 | fee_type | 否 | String(8) | CNY | 貨幣類(lèi)型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見(jiàn)貨幣類(lèi)型 |
應(yīng)結(jié)訂單金額 | settlement_total_fee | 否 | int | 100 | 當(dāng)訂單使用了免充值型優(yōu)惠券后返回該參數(shù),應(yīng)結(jié)訂單金額=訂單金額-免充值優(yōu)惠券金額。 |
現(xiàn)金支付金額 | cash_fee | 是 | int | 100 | 現(xiàn)金支付金額訂單現(xiàn)金支付金額,詳見(jiàn)支付金額 |
現(xiàn)金支付貨幣類(lèi)型 | cash_fee_type | 否 | String(16) | CNY | 貨幣類(lèi)型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見(jiàn)貨幣類(lèi)型 |
代金券金額 | coupon_fee | 否 | int | 100 | “代金券或立減優(yōu)惠”金額<=訂單總金額,訂單總金額-“代金券或立減優(yōu)惠”金額=現(xiàn)金支付金額,詳見(jiàn)支付金額 |
代金券使用數(shù)量 | coupon_count | 否 | int | 1 | 代金券或立減優(yōu)惠使用數(shù)量 |
代金券ID | coupon_id_$n | 否 | String(20) | 10000 | 代金券或立減優(yōu)惠ID, $n為下標(biāo),從0開(kāi)始編號(hào) |
代金券類(lèi)型 | coupon_type_$n | 否 | String | CASH | CASH--充值代金券 NO_CASH---非充值優(yōu)惠券 開(kāi)通免充值券功能,并且訂單使用了優(yōu)惠券后有返回(取值:CASH、NO_CASH)。$n為下標(biāo),從0開(kāi)始編號(hào),舉例:coupon_type_$0 |
單個(gè)代金券金額 | coupon_fee_$n | 否 | int | 100 | 單個(gè)代金券或立減優(yōu)惠支付金額, $n為下標(biāo),從0開(kāi)始編號(hào) |
微信支付訂單號(hào) | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信支付訂單號(hào) |
商戶(hù)訂單號(hào) | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商戶(hù)系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi)(最少6個(gè)字符),只能是數(shù)字、大小寫(xiě)字母_-|*且在同一個(gè)商戶(hù)號(hào)下唯一。詳見(jiàn)商戶(hù)訂單號(hào) |
商家數(shù)據(jù)包 | attach | 否 | String(128) | 123456 | 商家數(shù)據(jù)包,原樣返回 |
支付完成時(shí)間 | time_end | 是 | String(14) | 20141030133525 | 訂單支付時(shí)間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見(jiàn)時(shí)間規(guī)則 |
交易狀態(tài)描述 | trade_state_desc | 是 | String(256) | 支付失敗,請(qǐng)重新下單支付 | 對(duì)當(dāng)前查詢(xún)訂單狀態(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>
<sub_mch_id><![CDATA[1900000109]]></sub_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>
錯(cuò)誤碼
名稱(chēng) | 描述 | 原因 | 解決方案 |
---|---|---|---|
ORDERNOTEXIST | 此交易訂單號(hào)不存在 | 查詢(xún)系統(tǒng)中不存在此交易訂單號(hào) | 該API只能查提交支付交易返回成功的訂單,請(qǐng)商戶(hù)檢查需要查詢(xún)的訂單號(hào)是否正確 |
SYSTEMERROR | 系統(tǒng)錯(cuò)誤 | 后臺(tái)系統(tǒng)返回錯(cuò)誤 | 系統(tǒng)異常,請(qǐng)?jiān)僬{(diào)用發(fā)起查詢(xún) |