JSAPI預(yù)簽約API
最新更新時間：2024.03.18 版本說明
該方式適用于微信公眾號內(nèi)發(fā)起簽約。用戶在完成簽約后可返回商戶簽約頁面。
注意： ? 商戶上送敏感信息時使用微信支付平臺公鑰加密，證書序列號包含在請求HTTP頭部的Wechatpay-Serial，詳見接口規(guī)則
注意： 1. 接口說明
適用對象： 直連模式 機構(gòu)模式
請求URL：https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/jsapi-pre-entrust-sign
請求方式：POST
Path指該參數(shù)為路徑參數(shù)
Query指該參數(shù)為URL參數(shù)
Body指該參數(shù)需在請求JSON傳參
時序圖
2. 請求參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1, 32] | 是 | Body商戶號綁定的AppID 注意：僅適用于直連模式 示例值：wxcbda96de0b165486 |
| 子商戶號 | sub_mchid | string[1, 32] | 是 | Body微信支付分配的子商戶號 注意：僅適用于機構(gòu)模式 示例值：10000097 |
| 服務(wù)商應(yīng)用ID | sp_appid | string[1, 32] | 是 | Body服務(wù)商綁定的AppID 注意：僅適用于機構(gòu)模式 示例值：wxcbda96de0b165486 |
| 子商戶應(yīng)用ID | sub_appid | string[1, 32] | 否 | Body發(fā)起簽約的子商戶號綁定的AppID 注意：僅適用于機構(gòu)模式 示例值：wxcbda96de0b165484 |
| 模板ID | plan_id | int | 是 | Body協(xié)議模板ID，該模板ID是商戶在向微信支付提交代扣權(quán)限申請時由微信支付生成 示例值：123 |
| 商戶側(cè)簽約協(xié)議號 | out_contract_code | string[1, 32] | 是 | Body商戶請求簽約時傳入的簽約協(xié)議號，商戶側(cè)須唯一 示例值：100001256 |
| 用戶賬戶展示名稱 | user_display_name | string[1, 32] | 是 | Body簽約用戶的名稱，用于頁面展示,不需要對值進行URL編碼，參數(shù)值不支持UTF8非3字節(jié)編碼的字符，例如表情符號，所以請勿傳微信昵稱到該字段 示例值：張三 |
| 簽約成功通知URL | success_notify_url | string[1, 256] | 是 | BodyHTTPS開頭的回調(diào)通知URL ,不需要對值進行URL編碼 示例值：https://yoursite.com |
| 商戶AppID下的用戶標(biāo)識 | openid | string[1, 128] | 是 | Body用戶在商戶AppID下的OpenID，服務(wù)商模式為子商戶下的用戶OpenID，可詳見獲取openid 示例值：ouFhd5X9s9WteC3eWRjXV3lea123 |
| 簽約完成跳轉(zhuǎn)URL | return_url | string[1, 256] | 否 | Body用來控制簽約頁面結(jié)束后的返回路徑（不傳此參數(shù)，則簽約完成后停留在微信內(nèi)）。非空時，URL路徑前綴需在申請模板時提供給微信支付運營人員配置，未配置或者前綴不匹配則不跳轉(zhuǎn) 示例值：https://yoursite.com |
| 過期時間 | expired_time | string[1, 64] | 否 | Body境外代扣簽約會話ID過期時間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為YYYY-MM-DDTHH:mm:ss+TIMEZONE，YYYY-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2021-11-20T13:29:35+08:00表示，北京時間2021年11月20日 13點29分35秒。 示例值：2021-11-20T13:29:35+08:00 |
請求示例
{
"appid": "wxcbda96de0b165486",
"expired_time": "2021-11-20T13:29:35+08:00",
"openid": "ouFhd5X9s9WteC3eWRjXV3lea123",
"out_contract_code": "100001256",
"plan_id": 123,
"return_url": "https://yoursite.com",
"success_notify_url": "https://yoursite.com",
"user_display_name": "張三"
}
3. 返回參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 簽約跳轉(zhuǎn)URL | sign_url | string[1,512] | 是 | 有效期為10分鐘，跳轉(zhuǎn)簽約頁面URL，用戶通過跳轉(zhuǎn)訪問此URL即可進入微信簽約頁面，進行簽約。簽約完成后，按照 return_appid 的描述跳轉(zhuǎn)回對應(yīng)的應(yīng)用 示例值：https://apihk.mch.weixin.qq.com/global/papay/contracts/login?os_session_id=2021120910391616228#wechat_redirect |
返回示例
{
"sign_url": "https://apihk.mch.weixin.qq.com/global/papay/contracts/login?os_session_id=2021120910391616228#wechat_redirect"
}
4. 錯誤碼
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 403 | CONTRACT_NOT_EXIST | Result Empty | 查詢的簽約協(xié)議不存在，或者傳入正確查詢參數(shù)重試 |
| 403 | CONTRACT_EXISTED | 已開通自動扣費服務(wù)功能，無需重復(fù)開通 | 已開通自動扣費服務(wù)功能，無需重復(fù)開通；如需重新簽約，需解約后再發(fā)起簽約 |
| 400 | PARAM_ERROR | 參數(shù)錯誤 | 傳入正確查詢參數(shù) |
| 500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 請稍等重試 |
頁面導(dǎo)航
