WEB預簽約API
最新更新時間:2021.12.08 版本說明
該方式適用于PC等使用瀏覽器的設備場景使用微信簽約扣款。商戶在網(wǎng)站后端通過微信支付WEB簽約接口獲取到簽約鏈接,在網(wǎng)站前端將簽約鏈接生成二維碼,引導用戶掃碼識別該鏈接,用戶訪問該鏈接進入代扣簽約頁面;用戶簽約完成后留在微信。WEB 端等待簽約回調(diào)通知,或者定時輪詢查詢用戶簽約狀態(tài),更新頁面內(nèi)容。
該方式適用于PC等使用瀏覽器的設備場景使用微信簽約扣款。商戶在網(wǎng)站后端通過微信支付WEB簽約接口獲取到簽約鏈接,在網(wǎng)站前端將簽約鏈接生成二維碼,引導用戶掃碼識別該鏈接,用戶訪問該鏈接進入代扣簽約頁面;用戶簽約完成后留在微信。WEB 端等待簽約回調(diào)通知,或者定時輪詢查詢用戶簽約狀態(tài),更新頁面內(nèi)容。
適用對象: 直連模式 機構模式
請求URL:https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/web-pre-entrust-sign
請求方式:POST
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
應用ID | appid | string[1, 32] | 是 | Body商戶號綁定的AppID 注意:僅適用于直連模式 示例值:wxcbda96de0b165486 |
子商戶號 | sub_mchid | string[1, 32] | 是 | Body微信支付分配的子商戶號 注意:僅適用于機構模式 示例值:10000097 |
服務商應用ID | sp_appid | string[1, 32] | 是 | Body服務商綁定的AppID 注意:僅適用于機構模式 示例值:wxcbda96de0b165486 |
子商戶應用ID | sub_appid | string[1, 32] | 否 | Body發(fā)起簽約的子商戶號綁定的AppID 注意:僅適用于機構模式 示例值:wxcbda96de0b165484 |
模板ID | plan_id | int | 是 | Body協(xié)議模板ID,該模板ID是商戶在向微信支付提交代扣權限申請時由微信支付生成 示例值:123 |
商戶側簽約協(xié)議號 | out_contract_code | string[1, 32] | 是 | Body商戶請求簽約時傳入的簽約協(xié)議號,商戶側須唯一 示例值: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 |
過期時間 | expired_time | string[1, 64] | 否 | Body境外代扣簽約會話ID過期時間,遵循rfc3339標準格式,格式為YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時分秒,TIMEZONE表示時區(qū)(+08:00表示東八區(qū)時間,領先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",
"out_contract_code": "100001256",
"plan_id": 123,
"success_notify_url": "https://yoursite.com",
"user_display_name": "張三"
}
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
簽約跳轉(zhuǎn)URL | sign_url | string[1, 512] | 是 | 有效期為10分鐘,跳轉(zhuǎn)簽約頁面URL,用戶通過跳轉(zhuǎn)訪問此URL即可進入微信簽約頁面,進行簽約。簽約完成后,按照 return_appid 的描述跳轉(zhuǎn)回對應的應用 示例值: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"
}
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
403 | CONTRACT_NOT_EXIST | Result Empty | 查詢的簽約協(xié)議不存在,或者傳入正確查詢參數(shù)重試 |
403 | CONTRACT_EXISTED | 已開通自動扣費服務功能,無需重復開通 | 已開通自動扣費服務功能,無需重復開通;如需重新簽約,需解約后再發(fā)起簽約 |
400 | PARAM_ERROR | 參數(shù)錯誤 | 傳入正確查詢參數(shù) |
500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 請稍等重試 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證