最新更新時(shí)間:2021.12.08 版本說明
該方式適用于手機(jī)、平板電腦等使用H5瀏覽器的設(shè)備場景使用微信簽約扣款。商戶在網(wǎng)站前端通過微信支付H5純簽約接口與用戶簽訂委托扣款協(xié)議,再通過后臺(tái)接口申請扣款來完成代扣交易。
適用對(duì)象:直連模式 機(jī)構(gòu)模式
請求URL:https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/h5-pre-entrust-sign
請求方式:POST
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1, 32] | 是 | body商戶號(hào)綁定的AppID 注意:僅適用于直連模式 示例值:wxcbda96de0b165486 |
子商戶號(hào) | sub_mchid | string[1, 32] | 是 | body微信支付分配的子商戶號(hào) 注意:僅適用于機(jī)構(gòu)模式 示例值:10000097 |
服務(wù)商應(yīng)用ID | sp_appid | string[1, 32] | 是 | body服務(wù)商綁定的AppID 注意:僅適用于機(jī)構(gòu)模式 示例值:wxcbda96de0b165486 |
子商戶應(yīng)用ID | sub_appid | string[1, 32] | 否 | body發(fā)起簽約的子商戶號(hào)綁定的AppID 注意:僅適用于機(jī)構(gòu)模式 示例值:wxcbda96de0b165484 |
模板ID | plan_id | int | 是 | body協(xié)議模板ID,該模板ID是商戶在向微信支付提交代扣權(quán)限申請時(shí)由微信支付生成 示例值:123 |
商戶側(cè)簽約協(xié)議號(hào) | out_contract_code | string[1, 32] | 是 | body商戶請求簽約時(shí)傳入的簽約協(xié)議號(hào),商戶側(cè)須唯一 示例值:100001256 |
用戶賬戶展示名稱 | user_display_name | string[1, 32] | 是 | body簽約用戶的名稱,用于頁面展示,不需要對(duì)值進(jìn)行URL編碼,參數(shù)值不支持UTF8非3字節(jié)編碼的字符,例如表情符號(hào),所以請勿傳微信昵稱到該字段 示例值:張三 |
簽約成功通知URL | success_notify_url | string[1, 256] | 是 | bodyHTTPS開頭的回調(diào)通知URL ,不需要對(duì)值進(jìn)行URL編碼 示例值:https://yoursite.com |
回調(diào)應(yīng)用AppID | return_appid | string[1, 32] | 否 | body用來控制簽約頁面結(jié)束后的返回路徑。 當(dāng)指定該字段時(shí),且商戶模板標(biāo)注商戶具有指定返回app的權(quán)限時(shí),簽約成功將返回return_appid指定的app應(yīng)用,如果不填且簽約發(fā)起時(shí)的瀏覽器UA可被微信識(shí)別,則跳轉(zhuǎn)到瀏覽器,否則留在微信 示例值:wxcbda96de0b165486 |
用戶客戶端IP | user_client_ip | string[1, 32] | 是 | body該字段要求填入用戶客戶端的IP,用戶簽約時(shí)會(huì)校驗(yàn)用戶客戶端IP與商戶傳的用戶客戶端IP一致,若不一致則視為商戶引導(dǎo)的用戶和實(shí)際訪問用戶不一致,會(huì)拒絕該簽約請求。 示例值:119.145.83.6 |
過期時(shí)間 | expired_time | string[1, 32] | 否 | body境外代扣簽約會(huì)話ID過期時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式,格式為YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2021-11-20T13:29:35+08:00表示,北京時(shí)間2021年11月20日 13點(diǎn)29分35秒。 示例值:2021-11-20T13:29:35+08:00 |
簽約完成跳轉(zhuǎn)URL | return_url | string[1, 256] | 否 | body用來控制簽約頁面結(jié)束后的返回路徑(不傳此參數(shù),則簽約完成后停留在微信內(nèi))。非空時(shí),URL路徑前綴需在申請模板時(shí)提供給微信支付運(yùn)營人員配置,未配置或者前綴不匹配則不跳轉(zhuǎn) 示例值:https://yoursite.com |
{
"appid": "wxcbda96de0b165486",
"expired_time": "2021-11-20T13:29:35+08:00",
"out_contract_code": "100001256",
"plan_id": 123,
"return_appid": "wxcbda96de0b165486",
"return_url": "https://yoursite.com",
"success_notify_url": "https://yoursite.com",
"user_client_ip": "119.145.83.6",
"user_display_name": "張三"
}
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
簽約跳轉(zhuǎn)URL | sign_url | string[1, 512] | 是 | 有效期為10分鐘,跳轉(zhuǎn)簽約頁面URL,用戶通過跳轉(zhuǎn)訪問此URL即可進(jìn)入微信簽約頁面,進(jìn)行簽約。簽約完成后,按照 return_appid 的描述跳轉(zhuǎn)回對(duì)應(yīng)的應(yīng)用 示例值:https://api.mch.weixin.qq.com/global/papay/contracts/login?os_session_id=2021120910391616228#wechat_redirect |
{
"sign_url": "https://api.mch.weixin.qq.com/global/papay/contracts/login?os_session_id=2021120910391616228#wechat_redirect"
}
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
403 | CONTRACT_NOT_EXIST | Result Empty | 查詢的簽約協(xié)議不存在,或者傳入正確查詢參數(shù)重試 |
403 | CONTRACT_EXISTED | 已開通自動(dòng)扣費(fèi)服務(wù)功能,無需重復(fù)開通 | 已開通自動(dòng)扣費(fèi)服務(wù)功能,無需重復(fù)開通;如需重新簽約,需解約后再發(fā)起簽約 |
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 傳入正確查詢參數(shù) |
500 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 請稍等重試 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證