注意
- 同樣的通知可能會多次發(fā)送給商戶系統(tǒng)。商戶系統(tǒng)必須能夠正確處理重復(fù)的通知。 推薦的做法是,當(dāng)商戶系統(tǒ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ù)混亂。
- 如果在所有通知頻率后沒有收到微信側(cè)回調(diào),商戶應(yīng)調(diào)用查詢訂單接口確認(rèn)訂單狀態(tài)。
特別提醒: 商戶系統(tǒng)對于開啟結(jié)果通知的內(nèi)容一定要做簽名驗(yàn)證,并校驗(yàn)通知的信息是否與商戶側(cè)的信息一致,防止數(shù)據(jù)泄露導(dǎo)致出現(xiàn)“假通知”,造成資金損失。
# 接口說明
支持商戶: 【普通服務(wù)商】
請求方式: 【POST】
回調(diào)URL: 該鏈接是通過設(shè)置代金券消息通知地址提交notify_url設(shè)置,必須為HTTPS協(xié)議。如果鏈接無法訪問,商戶將無法接收到微信通知。 通知URL必須為直接可訪問的URL,不能攜帶參數(shù)。示例:https://pay.wechatpay.cn.com/wxpay/pay.action
# 通知規(guī)則
用戶使用券后,微信會把相關(guān)核銷券信息發(fā)送給商戶,商戶需要接收處理,并按照文檔規(guī)范返回應(yīng)答。出于安全的考慮,我們對核銷券信息數(shù)據(jù)進(jìn)行了加密,商戶需要先對通知數(shù)據(jù)進(jìn)行解密,才能得到核銷券信息數(shù)據(jù)。
對后臺通知交互時,如果微信收到應(yīng)答不是成功或超時,微信認(rèn)為通知失敗,微信會通過一定的策略定期重新發(fā)起通知,盡可能提高通知的成功率,但微信不保證通知最終能成功。(通知頻率為1min1次,總計9次)
# 通知報文
核銷券信息通知是以POST 方法訪問商戶設(shè)置的通知URL,通知的數(shù)據(jù)以JSON 格式通過請求主體(BODY)傳輸。通知的數(shù)據(jù)包括了加密的核銷券信息詳情。
注意
由于涉及到回調(diào)加密和解密,商戶必須先設(shè)置好APIv3密鑰后才能解密回調(diào)通知,APIv3密鑰設(shè)置文檔指引詳見APIv3密鑰設(shè)置指引 (opens new window))
# 步驟說明
# 步驟一:驗(yàn)證簽名
微信支付會對發(fā)送給商戶的通知進(jìn)行簽名,并將簽名值放在通知的HTTP頭Wechatpay-Signature。商戶應(yīng)當(dāng)驗(yàn)證簽名,以確認(rèn)請求來自微信,而不是其他的第三方。簽名驗(yàn)證的算法請參考 《微信支付API v3簽名驗(yàn)證》。
# 步驟二:參數(shù)解密
為了保證安全性,微信支付在回調(diào)通知,對關(guān)鍵信息進(jìn)行了AES-256-GCM加密。商戶應(yīng)當(dāng)按照以下的流程進(jìn)行解密關(guān)鍵信息,解密的流程:
- 用商戶平臺上設(shè)置的APIv3密鑰【微信服務(wù)商平臺 (opens new window)—>賬戶設(shè)置—>API安全—>設(shè)置APIv3密鑰】,記為key;
- 獲取resource.algorithm中描述的算法(目前為AEAD_AES_256_GCM),以及resource.nonce和resource.associated_data;
- 使用key、nonce和associated_data,對數(shù)據(jù)密文resource.ciphertext進(jìn)行解密,得到JSON形式的資源對象。
注意
- AEAD_AES_256_GCM算法的接口細(xì)節(jié),請參考rfc5116 (opens new window)。微信支付使用的密鑰key長度為32個字節(jié),隨機(jī)串nonce長度12個字節(jié),associated_data長度小于16個字節(jié)并可能為空。
- Java回調(diào)解密Json取值不帶引號。
# 字段說明
# 通知簽名
# 通知參數(shù)
- id 必填 string(36)通知的唯一ID。
- create_time 必填 string(32)通知創(chuàng)建的時間, 遵循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表示北京時間2015年05月20日13點(diǎn)29分35秒。 - event_type 必填 string(32)通知的類型,代金券用券回調(diào)通知的類型為COUPON.USE。
- resource_type 必填 string(32)通知的資源數(shù)據(jù)類型,代金券用券回調(diào)通知為encrypt-resource。
- summary 必填 string(64)回調(diào)摘要
- resource 必填 object通知資源數(shù)據(jù)
- 屬性
核銷券成功結(jié)果通知
1{2 "id": "EV-2018022511223320873",3 "create_time": "2015-05-20T13:29:35+08:00",4 "resource_type": "encrypt-resource",5 "event_type": "TRANSACTION.SUCCESS",6 "summary": "用券成功",7 "resource": {8 "original_type": "coupon",9 "algorithm": "AEAD_AES_256_GCM",10 "ciphertext": "",11 "associated_data": "",12 "nonce": ""13 }14}
# resource解密后字段
- stock_creator_mchid 必填 string(20)批次創(chuàng)建方商戶號。
- stock_id 必填 string(20)微信為每個代金券批次分配的唯一ID。
- coupon_id 必填 string(20)微信為代金券或消費(fèi)金唯一分配的id。
- singleitem_discount_off 選填 object單品優(yōu)惠特定信息。
- 屬性
- discount_to 選填 object減至優(yōu)惠限定字段,僅減至優(yōu)惠場景有返回。
- 屬性
- coupon_name 必填 string(20)券或消費(fèi)金名稱
- status 必填 string(16)券或消費(fèi)金狀態(tài):SENDED:可用USED:已實(shí)扣EXPIRED:已過期
- description 必填 string(3000)券或消費(fèi)金描述說明字段。
- create_time 必填 string(32)領(lǐng)券時間,遵循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.120+08:00表示,北京時間2015年5月20日 13點(diǎn)29分35秒。 - coupon_type 必填 string(16)券或消費(fèi)金類型:NORMAL:滿減券CUT_TO:減至券
- no_cash 必填 bool是否無資金流。枚舉值:true:是false:否
- available_begin_time 必填 string(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-05-20T13:29:35+08:00表示,北京時間2015年5月20日 13點(diǎn)29分35秒。 - available_end_time 必填 string(32)可用結(jié)束時間,遵循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表示,北京時間2015年5月20日 13點(diǎn)29分35秒。 - singleitem 必填 bool是否單品優(yōu)惠。枚舉值:true:是false:否
- normal_coupon_information 選填 object普通滿減券或消費(fèi)金面額、門檻信息。
- 屬性
- consume_information 選填 object已實(shí)扣代金券或消費(fèi)金信息。
- 屬性
- business_type 選填 string(256)細(xì)分業(yè)務(wù)類型,枚舉值:MULTIUSE:消費(fèi)金,僅有當(dāng)business_type=MULTIUSE時,才會返回
對resource對象進(jìn)行解密后,得到的資源對象示例
1{ 2 "stock_creator_mchid": "9800064", 3 "stock_id": "9865888", 4 "coupon_id": "98674556",5 "singleitem_discount_off": { 6 "single_price_max": 100 7 }, 8 "discount_to": { 9 "cut_to_price": 100, 10 "max_price": 10 11 }, 12 "coupon_name": "微信支付代金券", 13 "status": "EXPIRED", 14 "description": "微信支付營銷", 15 "create_time": "2015-05-20T13:29:35+08:00", 16 "coupon_type": "CUT_TO", 17 "no_cash": true, 18 "available_begin_time": "2015-05-20T13:29:35+08:00", 19 "available_end_time": "2015-05-20T13:29:35+08:00", 20 "singleitem": true, 21 "normal_coupon_information": { 22 "coupon_amount": 100, 23 "transaction_minimum": 100 24 }, 25 "consume_information": { 26 "consume_time": "2015-05-20T13:29:35+08:00", 27 "consume_mchid": "9856081", 28 "transaction_id": "4200752501201407033233368018", 29 "consume_amount": 50,30 "goods_detail": [ 31 { 32 "goods_id": "a_goods1", 33 "quantity": 7, 34 "price": 1, 35 "discount_amount": 4 36 } 37 ] 38 },39 "business_type": "MULTIUSE"40}
# 通知應(yīng)答
接收成功: HTTP應(yīng)答狀態(tài)碼需返回200或204,無需返回應(yīng)答報文。
接收失敗: HTTP應(yīng)答狀態(tài)碼需返回5XX或4XX,同時需返回應(yīng)答報文,格式如下:
- code 必填 string(32)【返回狀態(tài)碼】
錯誤碼,SUCCESS為清算機(jī)構(gòu)接收成功,其他錯誤碼為失敗。 - message 選填 string(256)【返回信息】
返回信息,如非空,為錯誤原因。
應(yīng)答示例
1{ 2 "code": "FAIL",3 "message": "失敗"4}