查詢簽約關系
應用場景
查詢簽約關系接口提供單筆簽約關系查詢:
- 查詢方式一:使用微信返回的委托代扣協(xié)議contract_id進行查詢
- 查詢方式二:plan_id+contract_code模式:傳入模板id和委托代扣協(xié)議號進行查詢
接口調(diào)用請求說明
請求Url | https://api.mch.weixin.qq.com/papay/querycontract |
---|---|
是否需要證書 | 否 |
請求方式 | post |
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 說明 |
---|---|---|---|---|---|
請求appid |
appid |
是 |
String(18) |
wxcbda96de0b165486 |
appid是商戶在微信申請公眾號或移動應用成功后分配的賬號ID,登錄平臺為mp.weixin.qq.com或open.weixin.qq.com |
商戶號 |
mch_id |
是 |
int |
10000098 |
商戶號是商戶在微信申請微信支付成功后分配的賬號ID,登錄平臺為www.tg885.com |
委托代扣協(xié)議id |
contract_id |
否 |
String(32) |
100005698 |
委托代扣簽約成功后由微信返回的委托代扣協(xié)議id,選擇contract_id查詢,則此參數(shù)必填 |
模板id |
plan_id |
否 |
int |
123 |
商戶在微信商戶平臺配置的代扣模板id,選擇plan_id+contract_code查詢,則此參數(shù)必填 |
簽約協(xié)議號 |
contract_code |
否 |
string(128) |
1023658866 |
商戶請求簽約時傳入的簽約協(xié)議號,商戶側須唯一。選擇plan_id+contract_code查詢,則此參數(shù)必填 |
版本號 |
version |
是 |
string |
1.0 |
固定值1.0 |
簽名 |
sign |
是 |
string |
E1EE61A91C8E90F299DE6AE075D60A2D |
簽名規(guī)則詳見簽名生成算法 |
數(shù)據(jù)示例(以contract_id查詢模式為例):
<xml>
?<sign>019C869758CC7F258C42F05CDB9EE361</sign>
?<mch_id>10000097</mch_id>
?<appid>wxf5b5e87a6a0fde94</appid>
?<contract_id>201509160000028648</contract_id>
?<version>1.0</version>
返回參數(shù)
字段名 | 變量名 | 必填 | 示例值 | 類型 | 說明 |
---|---|---|---|---|---|
返回狀態(tài)碼 |
return_code |
是 |
SUCCESS |
String(16) |
SUCCESS/FAIL |
返回信息 |
return_msg |
否 |
|
String(128) |
返回信息,如非空,為錯誤原因 |
以下字段在return_code為SUCCESS的時候返回 | |||||
業(yè)務結果 |
result_code |
是 |
SUCCESS |
String(16) |
SUCCESS/FAIL |
以下字段在return_code 和result_code都為SUCCESS的時候有返回 | |||||
商戶號 |
mch_id |
是 |
10000098 |
int |
微信支付分配的商戶號 |
公眾賬號id |
appid |
是 |
wxcbda96de0b165486 |
String(32) |
微信支付分配的公眾賬號id |
委托代扣協(xié)議id |
contract_id |
是 |
100005698 |
String(32) |
簽約成功后,微信返回的委托代扣協(xié)議id |
模板id |
plan_id |
是 |
123 |
int |
商戶在微信商戶平臺設置的代扣協(xié)議模板id |
請求序列號 |
request_serial |
是 |
1695 |
Uint64 |
商戶請求簽約時的序列號,商戶側須唯一,純數(shù)字。長度不超過12位 |
簽約協(xié)議號 |
contract_code |
是 |
1023658866 |
String(128) |
商戶請求簽約時傳入的簽約協(xié)議號,商戶側須唯一 |
用戶賬戶展示名稱 |
contract_display_account |
是 |
張三 |
String(128) |
簽約用戶的名稱,用于頁面展示 |
協(xié)議狀態(tài) |
contract_state |
是 |
1 |
int |
0-已簽約? |
協(xié)議簽署時間 |
contract_signed_time |
是 |
2015-07-01 10:00:00 |
String |
協(xié)議簽署時間 |
協(xié)議到期時間 |
contract_expired_time |
是 |
2016-07-01 10:00:00 |
String |
協(xié)議到期時間 |
協(xié)議解約時間 |
contract_terminated_time |
否 |
2015-09-01 10:00:00 |
String |
當contract_state=1時,該值有效 |
協(xié)議解約方式 |
contract_termination_mode |
否 |
3 |
int |
當contract_state=1時,該值有效 |
簽名 |
sign |
是 |
C380BEC2BFD727A4B6845133519F3AD6 |
String(32) |
詳見簽名生成算法 |
解約備注 |
contract_termination_remark |
否 |
解約原因 |
String(512) |
當contract_state=1時,該值有效 |
用戶標識 |
openid |
是 |
ozoKAt9TIPHfwVMkcniiNKZ1vbyw |
String |
商戶appid下的用戶唯一標識 |
以下字段在result_code為FAIL的時候有返回 | |||||
錯誤代碼 |
err_code |
是 |
SIGN_ERROR |
String(32) |
錯誤碼 |
錯誤代碼描述 |
err_code_des |
是 |
簽名錯誤 |
String(32) |
錯誤碼描述 |
示例:
<xml>
<return_code>
<![CDATA[SUCCESS]]>
</return_code>
<result_code>
<![CDATA[SUCCESS]]>
</result_code>
<mch_id>
<![CDATA[80000000]]>
</mch_id>
<appid>
<![CDATA[wx426b3015555b46be]]>
</appid>
<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>1438141845</contract_signed_time>
<contract_expired_time>1453953047</contract_expired_time>
<contract_terminated_time>1438157486</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>
錯誤碼
錯誤碼 |
描述 |
解決方案 |
---|---|---|
SIGN_ERROR |
簽名錯誤 |
驗證簽名算法 |
PARAMETER FAIL |
參數(shù)錯誤 |
驗證參數(shù) |
XML FAIL |
XML格式錯誤 |
檢查XML格式 |
RESULT NULL |
查詢?yōu)榭? |
傳入正確查詢參數(shù) |
-48 |
MERCHANT PERMISSION ERROR |
確認商戶權限(包含appid和mchid綁定關系) |
25 |
查詢簽約關系不存在 |
確認簽約關系 |