最新更新時(shí)間：2023.05.18 版本說(shuō)明
外部App拉起微信客戶端發(fā)起簽約前，需先后臺(tái)調(diào)用預(yù)簽約接口完成預(yù)簽約，獲取pre_entrustweb_id，再拉起微信客戶端，完成簽約，返回App。
? 該業(yè)務(wù)接口暫未全面開(kāi)放，暫只支持由微信支付運(yùn)營(yíng)人員代為申請(qǐng)，如有需求請(qǐng)咨詢與您對(duì)接的微信支付運(yùn)營(yíng)人員。如無(wú)對(duì)接的微信支付人員，請(qǐng)等待產(chǎn)品全面開(kāi)放，我們將另行通知。
適用對(duì)象：服務(wù)商
請(qǐng)求URL： https://api.mch.weixin.qq.com/papay/partner/preentrustweb
請(qǐng)求方式： POST
數(shù)據(jù)格式： XML
簽名方式： HMAC-SHA256、MD5
是否需要證書： 否
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1,32] | 是 | 服務(wù)商申請(qǐng)的公眾號(hào)或移動(dòng)應(yīng)用appid。 示例值：wxcbda96de0b165486 |
| 商戶號(hào) | mch_id | string[1,32] | 是 | 商戶號(hào)是商戶在微信申請(qǐng)微信支付成功后分配的賬號(hào)ID，登錄平臺(tái)為www.tg885.com 示例值：1200009811 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 子商戶號(hào)綁定的appid(非必填，如需操作，需要服務(wù)商在商戶平臺(tái)為子商戶綁定) 示例值：wxcbda96de0b165489 |
| 子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 示例值：1900000109 |
| 模板id | plan_id | string[1,28] | 是 | 協(xié)議模板id，設(shè)置路徑見(jiàn)開(kāi)發(fā)步驟。 示例值：12535 |
| 簽約協(xié)議號(hào) | contract_code | string[1,128] | 是 | 商戶側(cè)的簽約協(xié)議號(hào)，由商戶生成，只能是數(shù)字、大小寫字母的描述。 示例值：100000 |
| 請(qǐng)求序列號(hào) | request_serial | int64 | 是 | 商戶請(qǐng)求簽約時(shí)的序列號(hào)，要求唯一性。禁止使用0開(kāi)頭，序列號(hào)主要用于排序，不作為查詢條件，純數(shù)字,范圍不能超過(guò)int64的范圍（9223372036854775807）。 示例值：1000 |
| 用戶賬戶展示名稱 | contract_display_account | string[1,128] | 是 | 簽約用戶的名稱，用于頁(yè)面展示，參數(shù)值不支持UTF8非3字節(jié)編碼的字符，例如表情符號(hào)，所以請(qǐng)勿傳微信昵稱到該字段 示例值：微信代扣 |
| 回調(diào)通知url | notify_url | string[1,256] | 是 | 用于接收簽約成功消息的回調(diào)通知地址，以http或https開(kāi)頭，通知url必須為外網(wǎng)可訪問(wèn)的url，不能攜帶參數(shù)。 |
| 版本號(hào) | version | string[1,8] | 是 | 固定值1.0 示例值：1.0 |
| 簽名類型 | sign_type | string[1,32] | 否 | MD5或者HMAC-SHA256，不填默認(rèn)MD5 注意：app預(yù)簽約的默認(rèn)簽名方式是(sign_type為空或無(wú)該字段)：MD5 示例值：MD5 |
| 簽名 | sign | string[1,64] | 是 | 詳見(jiàn)簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 時(shí)間戳 | timestamp | string[1,10] | 是 | 系統(tǒng)當(dāng)前時(shí)間，10位 示例值：1414488825 |
| 返回app | return_app | string[1,1] | 否 | 用來(lái)控制簽約頁(yè)面結(jié)束后的返回路徑（不傳此參數(shù)，則簽約完成后停留在微信內(nèi)）。 Y表示返回app, 不填則不返回 注：簽約參數(shù)appid必須為發(fā)起簽約的app所有，且在微信開(kāi)放平臺(tái)注冊(cè)過(guò)。 ios和android用戶點(diǎn)完成按鈕才返回原APP，直接右劃關(guān)閉頁(yè)面或左上角不支持返回APP 示例值：Y |
<xml>
<appid>wxcbda96de0b165486</appid>
<mch_id>1200009811</mch_id>
<sub_appid>wxcbda96de0b165489</sub_appid>
<sub_mch_id>1900000109</sub_mch_id>
<plan_id>12535</plan_id>
<contract_code>100000</contract_code>
<request_serial>1000</request_serial>
<contract_display_account>微信代扣</contract_display_account>
<notify_url>https://weixin.qq.com</notify_url>
<version>1.0</version>
<sign_type>MD5</sign_type>
<sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
<timestamp>1414488825</timestamp>
<return_app>Y</return_app>
</xml>
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 非簽約結(jié)果標(biāo)識(shí)，簽約發(fā)起是否成功需要查看result_code來(lái)判斷。 示例值：SUCCESS |
| 返回信息 | return_msg | string[1,128] | 否 | 返回信息，如非空，為錯(cuò)誤原因 如：簽名失敗 等。 示例值：簽名失敗 |
以下字段在return_code為SUCCESS的時(shí)候有返回
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值：SUCCESS |
| 錯(cuò)誤代碼 | err_code | string[1,32] | 否 | 錯(cuò)誤碼 示例值：SIGN_ERROR |
| 錯(cuò)誤代碼描述 | err_code_des | string[1,32] | 否 | 錯(cuò)誤碼描述 示例值：簽名錯(cuò)誤 |
| 請(qǐng)求appid | appid | string[1,32] | 是 | 微信開(kāi)放平臺(tái)審核通過(guò)的應(yīng)用APPID（請(qǐng)登錄開(kāi)放平臺(tái)查看，注意與公眾號(hào)的APPID不同） 示例值：wxcbda96de0b165486 |
| 商戶號(hào) | mch_id | string[1,32] | 是 | 商戶號(hào)是商戶在微信申請(qǐng)微信支付成功后分配的賬號(hào)ID，登錄平臺(tái)為www.tg885.com 示例值：1200009811 |
| 子商戶公眾賬號(hào)ID | sub_appid | string[1,32] | 否 | 子商戶號(hào)綁定的APP的appid(非必填，如需操作，需要服務(wù)商在商戶平臺(tái)為子商戶綁定) 示例值：wxcbda96de0b165489 |
| 子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 示例值：1900000109 |
| 簽名 | sign | string[1,32] | 是 | 詳見(jiàn)簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 隨機(jī)字符串 | nonce_str | string[1,64] | 是 | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
以下字段在return_code 、result_code都為SUCCESS時(shí)有返回
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 預(yù)簽約id | pre_entrustweb_id | string[1,128] | 是 | 預(yù)簽約id，兩個(gè)小時(shí)內(nèi)有效 示例值：5778aadY9nltAsZzXixCkFIGYnV2V |
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<result_code><![CDATA[SUCCESS]]></result_code>
<appid><![CDATA[wxcbda96de0b165486]]></appid>
<mch_id><![CDATA[10000098]]></mch_id>
<sub_appid><![CDATA[wxcbda96de0b165489]]></sub_appid>
<sub_mch_id><![CDATA[1900000109]]></sub_mch_id>
<nonce_str><![CDATA[IITRi8Iabbblz1Jc]]></nonce_str>
<sign><![CDATA[E1EE61A91C8E90F299DE6AE075D60A2D]]></sign>
<pre_entrustweb_id><![CDATA[5778aadY9nltAsZzXixCkFIGYnV2V]]></pre_entrustweb_id>
</xml>
| 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|
| SYSTEMERROR | 接口返回錯(cuò)誤 | 請(qǐng)使用相同參數(shù)再次調(diào)用API |
| PARAMERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)根據(jù)接口返回的詳細(xì)信息檢查您的程序 |
| SIGNERROR | 簽名錯(cuò)誤 | 請(qǐng)根據(jù)指引生成正確簽名 |
| PAYAUTHERROR | 權(quán)限校驗(yàn)錯(cuò)誤 | 確認(rèn)商戶委托代扣權(quán)限權(quán)限 |
一、該接口需要額外申請(qǐng)OpenBusinessWebview權(quán)限，請(qǐng)聯(lián)系對(duì)接您的運(yùn)營(yíng)同學(xué)協(xié)助申請(qǐng)，具體參看接入流程
郵件模板如下：
標(biāo)題：OpenBusinessWebview權(quán)限申請(qǐng)_APP純簽約
正文：
（1）說(shuō)明使用背景
（2）appid、mchid（appid和mchid需要有綁定關(guān)系）
二、在微信開(kāi)放平臺(tái)（open.weixin.qq.com）注冊(cè)APP信息
三、在開(kāi)放平臺(tái)-資源中心下載SDK：資源下載
四、按照下面的接口指引文檔完成對(duì)接
適用對(duì)象： 服務(wù)商
請(qǐng)求方式： POST
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 預(yù)簽約id | pre_entrustweb_id | string[1,128] | 是 | 預(yù)簽約id 示例值：5778aadY9nltAsZzXixCkFIGYnV2V |
WXOpenBusinessWebViewReq *req = [[WXOpenBusinessWebViewReq alloc] init];
req.businessType =12; //固定值
NSMutableDictionary *queryInfoDic = [NSMutableDictionary dictionary];
[queryInfoDic setObject:"5778aadY9nltAsZzXixCkFIGYnV2V" forKey:"pre_entrustweb_id"];
req.queryInfoDic = queryInfoDic;
[WxApi sendReq:req];