最新更新時間:2020.09.29 版本說明
查詢簽約關(guān)系接口提供單筆簽約關(guān)系查詢。
? 查詢簽約關(guān)系可通過下面兩種方式查詢:
方式一:使用微信返回的委托代扣協(xié)議contract_id進行查詢。
方式二:plan_id+contract_code模式:傳入模板id和簽約協(xié)議號進行查詢。
兩種查詢方式返回結(jié)果相同
適用對象:服務(wù)商
請求URL: https://api.mch.weixin.qq.com/papay/partner/querycontract
請求方式: POST
數(shù)據(jù)格式: XML
是否需要證書: 否
請求頻率限制:默認300qps
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 服務(wù)商申請的公眾號或移動應(yīng)用appid。 示例值:wxcbda96de0b165486 |
商戶號 | mch_id | string[1,32] | 是 | 商戶號是商戶在微信申請微信支付成功后分配的賬號ID,登錄平臺為www.tg885.com 示例值:1200009811 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 子商戶號綁定的appid(非必填,如需操作,需要服務(wù)商在商戶平臺為子商戶綁定) 示例值:wxcbda96de0b165489 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 示例值:1900000109 |
委托代扣協(xié)議id | contract_id | string[1,32] | 是 | 委托代扣簽約成功后由微信返回的委托代扣協(xié)議id,選擇contract_id查詢,則此參數(shù)必填 示例值:100005698 |
版本號 | version | string[1,8] | 是 | 固定值1.0 示例值:1.0 |
簽名 | sign | string[1,64] | 是 | 簽名規(guī)則詳見簽名生成算法 示例值:E1EE61A91C8E90F299DE6AE075D60A2D |
<xml>
<sign>019C869758CC7F258C42F05CDB9EE361</sign>
<mch_id>10000097</mch_id>
<sub_mch_id>1900000109</sub_mch_id>
<appid>wxf5b5e87a6a0fde94</appid>
<contract_id>201509160000028648</contract_id>
<version>1.0</version>
</xml>
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 服務(wù)商申請的公眾號或移動應(yīng)用appid。 示例值:wxcbda96de0b165486 |
商戶號 | mch_id | string[1,32] | 是 | 商戶號是商戶在微信申請微信支付成功后分配的賬號ID,登錄平臺為www.tg885.com 示例值:1200009811 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 子商戶號綁定的appid(非必填,如需操作,需要服務(wù)商在商戶平臺為子商戶綁定) 示例值:wxcbda96de0b165489 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 示例值:1900000109 |
模板id | plan_id | string[1,128] | 是 | 商戶在微信商戶平臺配置的代扣模板id,選擇plan_id+contract_code查詢,則此參數(shù)必填 示例值:123 |
簽約協(xié)議號 | contract_code | string[1,128] | 是 | 商戶請求簽約時傳入的簽約協(xié)議號,商戶側(cè)須唯一。選擇plan_id+contract_code查詢,則此參數(shù)必填 示例值:1023658866 |
版本號 | version | string[1,8] | 是 | 固定值1.0 示例值:1.0 |
簽名 | sign | string[1,64] | 是 | 簽名規(guī)則詳見簽名生成算法 示例值:E1EE61A91C8E90F299DE6AE075D60A2D |
<xml>
<sign>019C869758CC7F258C42F05CDB9EE361</sign>
<mch_id>10000097</mch_id>
<sub_mch_id>1900000109</sub_mch_id>
<appid>wxf5b5e87a6a0fde94</appid>
<plan_id>123</plan_id>
<contract_code>1023658866</contract_code>
<version>1.0</version>
</xml>
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 示例值:SUCCESS |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,為錯誤原因 如:簽名失敗 等。 示例值:簽名失敗 |
以下字段在return_code為SUCCESS的時候有返回
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值:SUCCESS |
以下字段在return_code 和result_code都為SUCCESS的時候有返回
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值:10000098 |
應(yīng)用ID | appid | string[1,32] | 是 | 服務(wù)商申請的公眾號或移動應(yīng)用appid。 示例值:wxcbda96de0b165486 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 子商戶號綁定的appid(非必填,如需操作,需要服務(wù)商在商戶平臺為子商戶綁定) 示例值:wxcbda96de0b165489 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 示例值:1900000109 |
委托代扣協(xié)議id | contract_id | string[1,32] | 是 | 簽約成功后,微信返回的委托代扣協(xié)議id 示例值:Wx15463511252015071056489715 |
模板id | plan_id | string[1,128] | 是 | 協(xié)議模板id 示例值:123 |
請求序列號 | request_serial | int64 | 是 | 商戶請求簽約時的序列號,商戶側(cè)須唯一。序列號主要用于排序,不作為查詢條件,純數(shù)字,范圍不能超過int64的范圍(9223372036854775807)。 示例值:1695 |
簽約協(xié)議號 | contract_code | string[1,128] | 是 | 簽約協(xié)議號 示例值:100001256 |
用戶賬戶展示名稱 | contract_display_account | string[1,128] | 是 | 簽約用戶的名稱,用于頁面展示,參數(shù)值不支持UTF8非3字節(jié)編碼的字符,例如表情符號,所以請勿傳微信昵稱到該字段 示例值:微信代扣 |
協(xié)議狀態(tài) | contract_state | int | 是 | 協(xié)議狀態(tài),枚舉值: 0:已簽約 1:未簽約 9:簽約進行中 示例值:1 |
協(xié)議簽署時間 | contract_signed_time | string[1,32] | 是 | 協(xié)議簽署時間 示例值:2015-07-01 10:00:00 |
協(xié)議到期時間 | contract_expired_time | string[1,32] | 是 | 協(xié)議到期時間 (目前協(xié)議時間為長期有效,可以忽略該字段) 示例值:2016-07-01 10:00:00 |
協(xié)議解約時間 | contract_terminated_time | string[1,32] | 否 | 當contract_state=1時,該值有效 示例值:2015-09-01 10:00:00 |
協(xié)議解約方式 | contract_termination_mode | int | 否 | 當contract_state=1時,該值有效 1:有效期過自動解約(預(yù)留功能) 2:用戶主動解約 3:商戶API解約 4:商戶平臺解約 5:注銷(用戶微信賬戶注銷) 7:用戶聯(lián)系客服發(fā)起的解約 示例值:3 |
簽名 | sign | string[1,64] | 是 | 詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
解約備注 | contract_termination_remark | string[1,512] | 否 | 當contract_state=1時,該值有效 示例值:解約原因 |
用戶標識 | openid | string[1,128] | 是 | 商戶appid下的用戶唯一標識 示例值:ozoKAt9TIPHfwVMkcniiNKZ1vbyw |
用戶子標識 | sub_openid | string[1,128] | 否 | sub_appid下,用戶的唯一標識 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
以下字段在result_code為FAIL的時候有返回
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
錯誤代碼 | err_code | string[1,32] | 是 | 錯誤碼 示例值:SIGN_ERROR |
錯誤代碼描述 | err_code_des | string[1,32] | 是 | 錯誤碼描述 示例值:簽名錯誤 |
<xml>
<return_code> <![CDATA[SUCCESS]]> </return_code>
<result_code> <![CDATA[SUCCESS]]> </result_code>
<mch_id> <![CDATA[80000000]]> </mch_id>
<appid> <![CDATA[wx426b3015555b46be]]> </appid>
<sub_mch_id> <![CDATA[10010405]]> </sub_mch_id>
<contract_id>203</contract_id>
<plan_id>66</plan_id>
<openid> <![CDATA[oHZx6uMbIG46UXQ3SKxVYEgw1LZs]]> </openid>
<request_serial>123</request_serial>
<contract_code> <![CDATA[1005]]> </contract_code>
<contract_display_account> <![CDATA[test]]> </contract_display_account>
<contract_state>1</contract_state>
<contract_signed_time>2015-07-01 10:00:00</contract_signed_time>
<contract_expired_time>2015-07-01 10:00:00</contract_expired_time>
<contract_terminated_time>2015-07-01 10:00:00</contract_terminated_time>
<contract_termination_mode>3</contract_termination_mode>
<contract_termination_remark> <![CDATA[delete ....]]> </contract_termination_remark>
<err_code>0</err_code>
<err_code_des> <![CDATA[SUCCESS]]> </err_code_des>
<sign> <![CDATA[8FC9DACB7DDF9B48333DCCC2224E0CAC]]> </sign>
</xml>
錯誤碼 | 描述 | 解決方案 |
---|---|---|
SIGN_ERROR | 簽名錯誤 | 驗證簽名算法 |
PARAMETER FAIL | 參數(shù)錯誤 | 驗證參數(shù) |
XML FAIL | XML格式錯誤 | 檢查XML格式 |
RESULT NULL | 查詢?yōu)榭?/td> | 傳入正確查詢參數(shù) |
-48 | MERCHANT PERMISSION ERROR | 確認商戶權(quán)限(包含appid和mchid綁定關(guān)系) |
-25 | 查詢簽約關(guān)系不存在 | 確認簽約關(guān)系 |