最新更新時(shí)間:2021.12.08 版本說明
用戶在商戶的APP中發(fā)起簽約,跳轉(zhuǎn)到微信客戶端簽約小程序完成簽約,簽約完成后重新打開商戶APP。 移動(dòng)應(yīng)用(APP)接入開放平臺(tái)SDK后,用戶即可以在 APP 中跳轉(zhuǎn)至微信某一小程序的指定頁(yè)面,完成服務(wù)后再跳回至商戶APP 。
? APP簽約分為兩個(gè)步驟,步驟1通過預(yù)簽約接口獲得session_id,再通過步驟2調(diào)起簽約
適用對(duì)象:直連模式 機(jī)構(gòu)模式
請(qǐng)求URL:https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/app-pre-entrust-sign
請(qǐng)求方式:POST
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請(qǐng)求JSON傳參
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
應(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)限申請(qǐng)時(shí)由微信支付生成 示例值:123 |
商戶側(cè)簽約協(xié)議號(hào) | out_contract_code | string[1, 32] | 是 | body商戶請(qǐng)求簽約時(shí)傳入的簽約協(xié)議號(hào),商戶側(cè)須唯一 示例值:100001256 |
用戶賬戶展示名稱 | user_display_name | string[1, 32] | 是 | body簽約用戶的名稱,用于頁(yè)面展示,不需要對(duì)值進(jìn)行URL編碼,參數(shù)值不支持UTF8非3字節(jié)編碼的字符,例如表情符號(hào),所以請(qǐng)勿傳微信昵稱到該字段 示例值:張三 |
簽約成功通知URL | success_notify_url | string[1, 256] | 是 | bodyHTTPS開頭的回調(diào)通知URL ,不需要對(duì)值進(jìn)行URL編碼 示例值:https://yoursite.com |
商戶AppID下的用戶標(biāo)識(shí) | openid | string[1, 128] | 否 | body用戶在商戶AppID下的OpenID,服務(wù)商模式為子商戶下的用戶OpenID 示例值:ouFhd5X9s9WteC3eWRjXV3lea123 |
用戶客戶端IP | user_client_ip | string[1, 32] | 否 | body該字段要求填入用戶客戶端的IP,用戶簽約時(shí)會(huì)校驗(yàn)用戶客戶端IP與商戶傳的用戶客戶端IP一致,若不一致則視為商戶引導(dǎo)的用戶和實(shí)際訪問用戶不一致,會(huì)拒絕該簽約請(qǐng)求。 示例值:119.145.83.6 |
過期時(shí)間 | expired_time | string[1, 64] | 否 | 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 |
{
"appid": "wxcbda96de0b165486",
"expired_time": "2021-11-20T13:29:35+08:00",
"openid": "ouFhd5X9s9WteC3eWRjXV3lea123",
"out_contract_code": "100001256",
"plan_id": 123,
"success_notify_url": "https://yoursite.com",
"user_client_ip": "119.145.83.6",
"user_display_name": "張三"
}
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
委托代扣簽約會(huì)話ID | session_id | string[1, 128] | 是 | 微信返回的委托代扣簽約會(huì)話ID 示例值:201710180325670965 |
{
"session_id": "201710180325670965"
}
狀態(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ò)誤 | 請(qǐng)稍等重試 |
App跳轉(zhuǎn)微信側(cè)小程序需要引用新的openSDK
Android openSDK下載地址(版本>=5.3.1):Android資源下載
Android 接入文檔鏈接:openSDK說明文檔
iOS openSDK下載地址(版本>=1.8.4):iOS資源下載
iOS 接入文檔鏈接:openSDK說明文檔
接口名稱:WXOpenBusinessView?
● iOS兼容性表現(xiàn):若微信版本 >= 7.0.3,開發(fā)者可以通過此openSDK接口跳轉(zhuǎn)到微信支付分小程序;若微信版本 < 7.0.3,開發(fā)者通過此openSDK接口可以跳轉(zhuǎn)到微信,但不能跳轉(zhuǎn)到微信支付分小程序,此時(shí)微信會(huì)提示用戶可能由于應(yīng)用的請(qǐng)求非法或者微信版本過低。
● Android兼容性表現(xiàn):若微信版本>=7.0.3,開發(fā)者可以通過此openSDK接口跳轉(zhuǎn)到微信支付分小程序;若微信版本< 7.0.3,開發(fā)者通過此openSDK接口不能跳轉(zhuǎn)到微信,此時(shí)開發(fā)者應(yīng)提示用戶更新微信版本。
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
跳轉(zhuǎn)類型 | businessType | string[1,32] | 是 | 固定值:wxpayOverseaEntrustAuthorization 示例值:wxpayOverseaEntrustAuthorization |
委托代扣簽約會(huì)話ID | sessionId | string[1, 128] | 是 | 預(yù)簽約API中的返回值 session_id,由 APP 預(yù)簽約接口獲得 示例值:201710180325670965 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證