商戶協(xié)議號查詢簽約API
最新更新時間：2022.08.04 版本說明
查詢簽約關(guān)系接口提供單筆簽約關(guān)系查詢， 查詢方式：plan_id + out_contract_no模式：傳入模板ID和委托代扣協(xié)議號進(jìn)行查詢。
注意： ? 商戶上送敏感信息時使用微信支付平臺公鑰加密，證書序列號包含在請求HTTP頭部的Wechatpay-Serial，詳見接口規(guī)則
注意： 1. 接口說明
適用對象： 直連模式 機(jī)構(gòu)模式
請求URL：https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/out-contract-code/{out_contract_code}
請求方式：GET
Path指該參數(shù)為路徑參數(shù)
Query指該參數(shù)為URL參數(shù)
Body指該參數(shù)需在請求JSON傳參
2. 請求參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1, 32] | 是 | Query商戶號綁定的appid 注意：僅適用于直連模式 示例值：wxcbda96de0b165486 |
| 子商戶號 | sub_mchid | string[1,32] | 是 | Query微信支付分配的子商戶號 注意：僅適用于機(jī)構(gòu)模式 示例值：10000097 |
| 服務(wù)商應(yīng)用ID | sp_appid | string[1,32] | 是 | Query服務(wù)商綁定的appid 注意：僅適用于機(jī)構(gòu)模式 示例值：wxcbda96de0b165486 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | Query發(fā)起簽約的子商戶號綁定的appid 注意：僅適用于機(jī)構(gòu)模式 示例值：wxcbda96de0b165484 |
| 模板ID | plan_id | int | 是 | Query商戶向微信支付申請代扣權(quán)限時，微信支付將會為商戶分配一個唯一的代扣模板ID，選擇plan_id+out_contract_no查詢，則此參數(shù)必填 示例值：123 |
| 簽約協(xié)議號 | out_contract_code | string[1,32] | 是 | Path商戶請求簽約時傳入的簽約協(xié)議號，商戶側(cè)須唯一。選擇plan_id+out_contract_no查詢，則此參數(shù)必填 示例值：1023658866 |
請求示例
https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/out-contract-code/100005698?appid=wxcbda96de0b165486&plan_id=123
3. 返回參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商戶號 | mchid | string[1,32] | 是 | 微信支付分配的商戶號 注意：僅適用于直連模式 示例值：10000091 |
| 應(yīng)用ID | appid | string[1,32] | 是 | 商戶號綁定的appid 注意：僅適用于直連模式 示例值：wxcbda96de0b165486 |
| 服務(wù)商商戶號 | sp_mchid | string[1,32] | 是 | 微信支付分配的機(jī)構(gòu)商戶號 注意：僅適用于機(jī)構(gòu)模式 示例值：10000098 |
| 子商戶號 | sub_mchid | string[1,32] | 是 | 微信支付分配的子商戶號 注意：僅適用于機(jī)構(gòu)模式 示例值：10000097 |
| 服務(wù)商應(yīng)用ID | sp_appid | string[1,32] | 是 | 服務(wù)商公眾號的appid 注意：僅適用于機(jī)構(gòu)模式 示例值：wxcbda96de0b165486 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 發(fā)起簽約的子商戶小程序appid 注意：僅適用于機(jī)構(gòu)模式 示例值：wxcbda96de0b165484 |
| 委托代扣協(xié)議ID | contract_id | string[1,64] | 是 | 簽約成功后，微信返回的委托代扣協(xié)議id 示例值：100005698 |
| 模板ID | plan_id | int | 是 | 商戶向微信支付申請代扣權(quán)限時，微信支付將會為商戶分配一個唯一的代扣模板ID 示例值：123 |
| 簽約協(xié)議號 | out_contract_code | string[1,32] | 是 | 商戶請求簽約時傳入的簽約協(xié)議號，商戶側(cè)須唯一 示例值：1023658866 |
| 用戶賬戶展示名稱 | user_display_name | string[1,32] | 是 | 簽約用戶的名稱，用于頁面展示 示例值：張三 |
| 協(xié)議狀態(tài) | state | string[1,32] | 是 | 簽約狀態(tài) NOTSIGN：未簽約 SIGNING：簽約中 SIGNED：已簽約 TERMINATING：解約中 TERMINATED：已解約 DELETE：已刪除 SIGNFAIL：簽約失敗 示例值：SIGNED |
| 協(xié)議簽署時間 | signed_time | string[1,64] | 是 | 協(xié)議簽署時間 示例值：2015-07-01T10:00:00+08:00 |
| 協(xié)議解約時間 | terminated_time | string[1,64] | 否 | 當(dāng)state=NOT SIGNED時，該值表示協(xié)議解約時間 示例值：2015-09-01T10:00:00+08:00 |
| 協(xié)議解約方式 | termination_mode | object | 否 | 解約方式 USER：用戶解約 MERCHANT：商戶解約 PLATFORM：商戶平臺解約 示例值：USER |
| 解約備注 | termination_note | string[1,256] | 否 | 當(dāng)state=NOT SIGNED時，該值表示解約備注 示例值：解約原因 |
| 商戶appid下的用戶標(biāo)識 | openid | string[1,128] | 是 | 用戶在商戶appid下的openid，服務(wù)商模式為子商戶下的用戶openid 示例值：ouFhd5X9s9WteC3eWRjXV3lea123 |
返回示例
{
"mchid": "10000100",
"appid": " wx426b3015555b46be ",
"contract_id": "203",
"plan_id": 66,
"openid": " oHZx6uMbIG46UXQ3SKxVYEgw1LZs ",
"out_contract_code": " 1005 ",
"user_display_name": " test ",
"state": "TERMINATED",
"signed_time": "2015-07-01T10:00:00+08:00",
"terminated_time": "2015-09-01T10:00:00+08:00",
"termination_mode": "USER",
"termination_note": " delete ...."
}
4. 錯誤碼
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 403 | CONTRACT_NOT_EXIST | Result Empty | 查詢的簽約協(xié)議不存在，或者傳入正確查詢參數(shù)重試 |
| 400 | PARAM_ERROR | 參數(shù)錯誤 | 傳入正確查詢參數(shù) |
| 500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 請稍等重試 |
頁面導(dǎo)航
