簽約與解約結(jié)果回調(diào)API
簽約、解約成功后（不成功不通知），微信會把相關(guān)簽約、解約信息異步通知給商戶。
注意：
● 同樣的通知可能會多次發(fā)送給商戶系統(tǒng)。商戶系統(tǒng)必須能夠正確處理重復(fù)的通知。推薦的做法是，當(dāng)收到通知進(jìn)行處理時，首先檢查對應(yīng)業(yè)務(wù)數(shù)據(jù)的狀態(tài)，判斷該通知是否已經(jīng)處理過，如果沒有處理過再進(jìn)行處理，如果處理過直接返回結(jié)果成功。在對業(yè)務(wù)數(shù)據(jù)進(jìn)行狀態(tài)檢查和處理之前，要采用數(shù)據(jù)鎖進(jìn)行并發(fā)控制，以避免函數(shù)重入造成的數(shù)據(jù)混亂。推薦的做法是，當(dāng)收到通知進(jìn)行處理時，首先檢查對應(yīng)業(yè)務(wù)數(shù)據(jù)的狀態(tài)，判斷該通知是否已經(jīng)處理過，如果沒有處理過再進(jìn)行處理，如果處理過直接返回結(jié)果成功。在對業(yè)務(wù)數(shù)據(jù)進(jìn)行狀態(tài)檢查和處理之前，要采用數(shù)據(jù)鎖進(jìn)行并發(fā)控制，以避免函數(shù)重入造成的數(shù)據(jù)混亂。
● 如果在所有通知頻率(4小時)后沒有收到微信側(cè)回調(diào)，商戶應(yīng)調(diào)用查詢訂單接口確認(rèn)訂單狀態(tài)。
特別提醒：商戶系統(tǒng)對于結(jié)果通知的內(nèi)容一定要做簽名驗證，并校驗通知的數(shù)據(jù)字段是否與商戶側(cè)的數(shù)據(jù)字段一致，防止數(shù)據(jù)泄漏導(dǎo)致出現(xiàn)“假通知”，造成資金損失。
1. 接口說明
適用對象： 直連模式 機構(gòu)模式
請求URL：簽約結(jié)果通知路徑為簽約接口商戶上傳的success_notify_url字段，解約結(jié)果通知路徑為商戶申請代扣權(quán)限與代扣模板ID時提供的解約回調(diào)地址。必須為https協(xié)議。如果鏈接無法訪問，商戶將無法接收到微信通知。通知url必須為直接可訪問的url，不能攜帶參數(shù)。示例：success_notify_url：“http://www.tg885.com/wxpay/pay.action”
請求方式：POST
2. 通知規(guī)則
簽約、解約成功后（不成功不通知），微信會把相關(guān)簽約、解約信息異步通知給商戶。 商戶需要接收處理，并返回應(yīng)答。出于安全的考慮，我們對通知結(jié)果數(shù)據(jù)進(jìn)行了加密，商戶需要先對通知數(shù)據(jù)進(jìn)行解密，才能得到結(jié)果數(shù)據(jù)。
對后臺通知交互時，如果微信收到商戶的應(yīng)答不是成功或超時，微信認(rèn)為通知失敗，微信會通過一定的策略定期重新發(fā)起通知，盡可能提高通知的成功率，但微信不保證通知最終能成功。（通知頻率為15/15/30/180/1800/1800/1800/1800/3600，單位：秒）
3. 通知報文
簽約、解約結(jié)果通知是以POST方法訪問商戶設(shè)置的通知url，通知的數(shù)據(jù)以JSON格式通過請求主體（BODY）傳輸。通知的數(shù)據(jù)包括了加密的支付結(jié)果詳情。
下面詳細(xì)描述證書解密的流程
1、從商戶平臺上獲取商戶的密鑰，記為“key”。
2、針對resource.algorithm中描述的算法（目前為AEAD_AES_256_GCM），取得對應(yīng)的參數(shù)nonce和associated_data。
3、使用key、nonce和associated_data，對數(shù)據(jù)密文resource.ciphertext進(jìn)行解密，得到JSON形式的資源對象
注意：AEAD_AES_256_GCM算法的接口細(xì)節(jié)，請參考rfc5116。微信支付使用的密鑰key長度為32個字節(jié)，隨機串nonce長度12個字節(jié)，associated_data長度小于16個字節(jié)并可能為空。
4. 請求參數(shù)
| 參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
| 通知ID |
id |
string[1,32] |
是 |
通知的唯一ID
示例值：EV-2018022511223320873 |
| 通知創(chuàng)建時間 |
create_time |
string[1,64] |
是 |
通知創(chuàng)建的時間，格式為rfc3339格式，如2018-06-08T10:34:56+08:00?代表北京時間2018年06月08日10時34分56秒
示例值：2018-06-08T10:34:56+08:00 |
| 通知類型 |
event_type |
string[1,32] |
是 |
通知的類型
簽約成功通知的類型為：PAPAY.SIGN
解約通知類型為：PAPAY.TERMINATE
示例值：PAPAY.SIGN |
| 通知數(shù)據(jù)類型 |
resource_type |
string[1,32] |
是 |
通知的資源數(shù)據(jù)類型，支付成功通知為encrypt-resource
示例值：encrypt-resource |
| 通知數(shù)據(jù) |
resource |
object |
是 |
通知資源數(shù)據(jù) |
| 參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
| 加密算法類型 |
algorithm |
string[1,32] |
是 |
對支付結(jié)果數(shù)據(jù)進(jìn)行加密的加密算法，目前只支持AEAD_AES_256_GCM
示例值：AEAD_AES_256_GCM |
| 數(shù)據(jù)密文 |
ciphertext |
string[1,1048576] |
是 |
Base64編碼后的支付結(jié)果數(shù)據(jù)密文 |
| 附加數(shù)據(jù) |
associated_data |
string[1,16] |
否 |
加密使用的附加數(shù)據(jù) |
| 隨機串 |
nonce |
string[1,32] |
是 |
加密使用的隨機串 |
|
5. 通知簽名
加密不能保證通知請求來自微信。微信會對發(fā)送給商戶的通知進(jìn)行簽名，并將簽名值放在通知的HTTP頭Wechatpay-Signature。商戶應(yīng)當(dāng)驗證簽名，以確認(rèn)請求來自微信，而不是其他的第三方。簽名驗證的算法請參考《微信支付API V3簽名驗證》。
{
"id":"EV-2018022511223320873",
"create_time":"20180225112233",
"resource_type":"encrypt-resource",
"event_type":"PAPAY.SIGN",
"resource" : {
"algorithm":"AEAD_AES_256_GCM",
"ciphertext": "...",
"nonce": "...",
"associated_data": ""
}
}
商戶對resource對象進(jìn)行解密后，得到的資源對象示例
{
"mchid": "10000091",
"out_contract_code": "100001256",
"plan_id": 123,
"contract_id": "Wx15463511252015071056489715",
"appid": "wxcbda96de0b165486",
"openid": "ouFhd5X9s9WteC3eWRjXV3lea123",
"contract_termination_mode": "USER",
"operate_time ": "2015-09-01T10: 00: 00+08: 00 "
}
{
"sp_mchid": "10000091",
"sub_mchid": "10000097",
"out_contract_code": "100001256",
"plan_id": 123,
"contract_id": "Wx15463511252015071056489715",
"sp_appid": "wxcbda96de0b165486",
"openid": "ouFhd5X9s9WteC3eWRjXV3lea123",
"contract_termination_mode": "USER",
"operate_time": "2015-09-01T10:00:00+08:00"
}
6. 簽約與解約結(jié)果參數(shù)
| 參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
| 商戶號 |
mchid |
string[1,32] |
是 |
微信支付分配的商戶號
注意：僅適用于直連模式
示例值：1900000109 |
| APPID |
appid |
string[1,32] |
是 |
商戶在微信開放平臺申請移動應(yīng)用對應(yīng)的APPID
注意：僅適用于直連模式
示例值：wx8888888888888888 |
| 機構(gòu)商戶號 |
sp_mchid |
string[1,32] |
是 |
微信支付分配的機構(gòu)商戶號
注意：僅適用于機構(gòu)模式
示例值：1900000100 |
| 子商戶號 |
sub_mchid |
string[1,32] |
是 |
微信支付分配的子商戶商戶號
注意：僅適用于機構(gòu)模式
示例值：1900000109 |
| 機構(gòu)APPID |
sp_appid |
string[1,32] |
是 |
機構(gòu)在微信公眾平臺申請服務(wù)號對應(yīng)的APPID
注意：僅適用于機構(gòu)模式
示例值：wx8888888888888888 |
| 子商戶APPID |
sub_appid |
string[1,32] |
否 |
子商戶在微信開放平臺申請移動應(yīng)用對應(yīng)的APPID
付款碼支付/掃碼支付/公眾號支付使用商戶公眾號appid
小程序支付使用商戶小程序appid
APP支付使用商戶APP應(yīng)用appid
注意：僅適用于機構(gòu)模式
示例值：wx8888888888888888 |
| 簽約協(xié)議號 |
out_contract_code |
string[1,32] |
是 |
商戶請求簽約時傳入的簽約協(xié)議號，商戶側(cè)須唯一
示例值：1023658866 |
| 委托代扣協(xié)議ID |
contract_id |
string[1,64] |
是 |
簽約成功后，微信返回的委托代扣協(xié)議id
示例值：100005698 |
| 模板ID |
plan_id |
int |
是 |
商戶向微信支付申請代扣權(quán)限時，微信支付將會為商戶分配一個唯一的代扣模板ID
示例值：123 |
| 用戶標(biāo)識 |
openid |
string[1,128] |
是 |
用戶在商戶appid對應(yīng)下的唯一標(biāo)識，需要傳appid才有返回
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
| 協(xié)議解約方式 |
contract_termination_mode |
string[1,64] |
否 |
解約方式
USER：用戶解約
MERCHANT：商戶解約
PLATFORM：商戶平臺解約
示例值：USER |
| 協(xié)議到期時間 |
contract_expire_time |
string[1,32] |
否 |
協(xié)議到期時間，遵循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小時，即北京時間）。
示例值：2015-05-20T13:29:35+08:00 |
| 操作時間 |
operate_time |
string[1,32] |
是 |
操作時間，遵循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小時，即北京時間）。
示例值：2015-09-01T10:00:00+08:00 |
7. 通知應(yīng)答
接收成功：HTTP應(yīng)答狀態(tài)碼需返回200或204，無需返回應(yīng)答報文。
接收失敗：HTTP應(yīng)答狀態(tài)碼需返回5XX或4XX，同時需返回應(yīng)答報文，格式如下：
注意：重試過多會導(dǎo)致微信支付端積壓過多通知而堵塞，影響其他正常通知。
| 參數(shù)名 |
變量 |
類型 |
必填 |
描述 |
| 返回狀態(tài)碼 |
code |
string[1,32] |
是 |
詳見下面返回狀態(tài)碼說明
示例值：SUCCESS
|
| 返回信息 |
message |
string[1,256] |
否 |
返回信息，為錯誤原因
示例值：系統(tǒng)錯誤
|
200
{
"code": "SUCCESS",
"message": "OK"
}
{
"code": "SYSTEM_ERROR",
"message": "系統(tǒng)失敗"
}
