最新更新時間:2021.1.14 版本說明
該接口提供所有微信支付訂單的查詢,商戶可以通過查詢訂單接口主動查詢訂單狀態(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);
適用對象:直連商戶 服務商
請求URL: https://api.mch.weixin.qq.com/pay/orderquery
冗災備用URL:https://api2.mch.weixin.qq.com/pay/orderquery(備用域名)見跨城冗災方案
請求方式: POST
數(shù)據(jù)格式: XML
是否需要證書: 否
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
應用ID | appid | string[1,32] | 是 | 微信分配的應用ID 示例值:wx8888888888888888 |
商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶應用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應用ID,如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意:僅適用于服務商模式 示例值:wx8888888888888888 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 注意:僅適用于服務商模式 示例值:1900000109 |
微信支付訂單號 | transaction_id | string[1,32] | 二選一 | 微信的訂單號,優(yōu)先使用 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string[1,32] | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 示例值:1217752501201407033233368018 |
|
隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
<transaction_id>1008450740201411110005820873</transaction_id>
<sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
</xml>:
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 示例值:SUCCESS |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 示例值:簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時候,包含以下字段
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
應用ID | appid | string[1,32] | 是 | 微信分配的應用ID 示例值:wx8888888888888888 |
商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶應用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應用ID,如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意:僅適用于服務商模式 示例值:wx8888888888888888 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 注意:僅適用于服務商模式 示例值:1900000109 |
隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
業(yè)務結果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值:SUCCESS |
錯誤代碼 | err_code | string[1,32] | 否 | 詳細參見錯誤列表 示例值:SYSTEMERROR |
錯誤代碼描述 | err_code_des | string[1,128] | 否 | 結果信息描述 示例值:系統(tǒng)錯誤 |
返回狀態(tài)碼(return_code)和業(yè)務結果(result_code)、交易狀態(tài)(trade_state)都為SUCCESS的時候,包含以下字段
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
設備號 | device_info | string[1,32] | 否 | 調(diào)用接口提交的終端設備號, 示例值:013467007045764 |
用戶標識 | openid | string[1,128] | 否 | 用戶在主商戶appid下的唯一標識 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
是否關注公眾賬號 | is_subscribe | string[1,1] | 是 | 用戶是否關注公眾賬號,枚舉值: Y:關注 N:未關注 (機構商戶不返回) 示例值:Y |
用戶子標識 | sub_openid | string[1,128] | 否 | t用戶在子商戶appid下的唯一標識 注意:僅適用于服務商模式 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
是否關注子公眾賬號 | sub_is_subscribe | string[1,1] | 否 | 用戶是否關注子公眾賬號,枚舉值: Y:關注 N:未關注 (機構商戶不返回) 示例值:Y |
交易類型 | trade_type | string[1,16] | 是 | JSAPI:JSAPI支付(或小程序支付) NATIVE:Native支付 APP:APP支付 MWEB:H5支付 說明詳見交易類型 示例值:JSAPI |
交易狀態(tài) | trade_state | string[1,32] | 是 | SUCCESS:支付成功 REFUND:轉入退款 NOTPAY:未支付 CLOSED:已關閉 REVOKED:已撤銷(刷卡支付) USERPAYING:用戶支付中 PAYERROR:支付失敗(其他原因,如銀行返回失敗) ACCEPT:已接收,等待扣款 示例值:JSAPI |
付款銀行 | bank_type | string[1,32] | 是 | 銀行類型,采用字符串類型的銀行標識 示例值:CMC |
+ 商品詳情 | detail | string[1,8192] | 否 | 商品詳細列表,使用Json格式。如果使用了單品優(yōu)惠,會有單品優(yōu)惠信息返回 示例值:JSAPI |
標價金額 | total_fee | int | 是 | 訂單總金額,單位為分 示例值:100 |
標價幣種 | fee_type | string[1,8] | 否 | 貨幣類型,符合ISO 4217標準的三位字母代碼,默認人民幣:CNY,其他值列表詳見貨幣類型 示例值:CNY |
應結訂單金額 | settlement_total_fee | int | 否 | 當訂單使用了免充值型優(yōu)惠券后返回該參數(shù),應結訂單金額=訂單金額-免充值優(yōu)惠券金額。 示例值:100 |
現(xiàn)金支付金額 | cash_fee | int | 是 | 現(xiàn)金支付金額訂單現(xiàn)金支付金額,詳見交易金額 示例值:100 |
現(xiàn)金支付貨幣類型 | cash_fee_type | string[1,16] | 否 | 貨幣類型,符合ISO 4217標準的三位字母代碼,默認人民幣:CNY,其他值列表詳見貨幣類型 示例值:CNY |
代金券金額 | coupon_fee | int | 否 | “代金券或立減優(yōu)惠”金額<=訂單總金額,訂單總金額-“代金券或立減優(yōu)惠”金額=現(xiàn)金支付金額,詳見交易金額 示例值:100 |
代金券使用數(shù)量 | coupon_count | int | 否 | 代金券或立減優(yōu)惠使用數(shù)量 示例值:1 |
代金券ID | coupon_id_$n | string[1,20] | 否 | 代金券或立減優(yōu)惠ID, $n為下標,從0開始編號 示例值:10000 |
代金券類型 | coupon_type_$n | String | 否 | CASH:充值代金券 NO_CASH:非充值優(yōu)惠券 開通免充值券功能,并且訂單使用了優(yōu)惠券后有返回(取值:CASH、NO_CASH)。$n為下標,從0開始編號,舉例:coupon_type_$0 示例值:CASH |
單個代金券金額 | coupon_fee_$n | int | 否 | 單個代金券或立減優(yōu)惠支付金額, $n為下標,從0開始編號 示例值:100 |
微信支付訂單號 | transaction_id | string[1,32] | 是 | 微信支付訂單號 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 示例值:1217752501201407033233368018 |
商家數(shù)據(jù)包 | attach | string[1,128] | 否 | 商家數(shù)據(jù)包,原樣返回 示例值:123456 |
支付完成時間 | time_end | string[1,14] | 是 | 訂單支付時間,格式為yyyyMMddHHmmss,如2009年12月25日9點10分10秒表示為20091225091010。其他詳見時間規(guī)則 示例值:20141030133525 |
交易狀態(tài)描述 | trade_state_desc | string[1,256] | 是 | 對當前查詢訂單狀態(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[Y]]></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 | 此交易訂單號不存在 | 該API只能查提交支付交易返回成功的訂單,請商戶檢查需要查詢的訂單號是否正確 |
SYSTEMERROR | 系統(tǒng)錯誤 | 系統(tǒng)異常,請再調(diào)用發(fā)起查詢 |