最新更新時(shí)間:2020.05.25版本說(shuō)明
微信支付分通過(guò)支付成功通知接口將用戶(hù)支付成功消息通知給商戶(hù)
? 同樣的通知可能會(huì)多次發(fā)送給商戶(hù)系統(tǒng)。商戶(hù)系統(tǒng)必須能夠正確處理重復(fù)的通知。 推薦的做法是,當(dāng)商戶(hù)系統(tǒng)收到通知進(jìn)行處理時(shí),先檢查對(duì)應(yīng)業(yè)務(wù)數(shù)據(jù)的狀態(tài),并判斷該通知是否已經(jīng)處理。如果未處理,則再進(jìn)行處理;如果已處理,則直接返回結(jié)果成功。在對(duì)業(yè)務(wù)數(shù)據(jù)進(jìn)行狀態(tài)檢查和處理之前,要采用數(shù)據(jù)鎖進(jìn)行并發(fā)控制,以避免函數(shù)重入造成的數(shù)據(jù)混亂。
? 如果在所有通知頻率(通知頻率為0s/15s/15s/30s/180s/1800s/1800s/1800s/1800s/3600s )后沒(méi)有收到微信側(cè)回調(diào),商戶(hù)應(yīng)調(diào)用查詢(xún)訂單接口確認(rèn)訂單狀態(tài)。
特別提醒:商戶(hù)系統(tǒng)對(duì)于支付成功通知的內(nèi)容一定要做簽名驗(yàn)證,并校驗(yàn)通知的信息是否與商戶(hù)側(cè)的信息一致,防止數(shù)據(jù)泄露導(dǎo)致出現(xiàn)“假通知”,造成資金損失。
適用對(duì)象:直連商戶(hù)
請(qǐng)求URL:該鏈接是通過(guò)商戶(hù)[創(chuàng)建支付分訂單]提交notify_url參數(shù),必須為https協(xié)議。如果鏈接無(wú)法訪問(wèn),商戶(hù)將無(wú)法接收到微信通知。 通知url必須為直接可訪問(wèn)的url,不能攜帶參數(shù)。示例: “http://www.tg885.com/wxpay/pay.action”
接口規(guī)則:http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
支付完成后,微信會(huì)把相關(guān)支付結(jié)果和訂單信息發(fā)送給商戶(hù),商戶(hù)需要接收處理該消息,并返回應(yīng)答。
對(duì)后臺(tái)通知交互時(shí),如果微信收到商戶(hù)的應(yīng)答不符合規(guī)范或超時(shí),微信認(rèn)為通知失敗,微信會(huì)通過(guò)一定的策略定期重新發(fā)起通知,盡可能提高通知的成功率,但微信不保證通知最終能成功。 (通知頻率為0s/15s/15s/30s/180s/1800s/1800s/1800s/1800s/3600s )
支付結(jié)果通知是以POST 方法訪問(wèn)商戶(hù)設(shè)置的通知url,通知的數(shù)據(jù)以JSON 格式通過(guò)請(qǐng)求主體(BODY)傳輸。通知的數(shù)據(jù)包括了加密的支付結(jié)果詳情。
(注:由于涉及到回調(diào)加密和解密,商戶(hù)必須先設(shè)置好apiv3秘鑰后才能解密回調(diào)通知,apiv3秘鑰設(shè)置文檔指引詳見(jiàn)APIv3秘鑰設(shè)置指引)
下面詳細(xì)描述對(duì)通知數(shù)據(jù)進(jìn)行解密的流程:
注: AEAD_AES_256_GCM算法的接口細(xì)節(jié),請(qǐng)參考rfc5116。微信支付使用的密鑰apiv3 key長(zhǎng)度為32個(gè)字節(jié),隨機(jī)串nonce長(zhǎng)度12個(gè)字節(jié),associated_data長(zhǎng)度小于16個(gè)字節(jié)并可能為空。
參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
通知ID | id | string[1,36] | 是 | 通知的唯一ID 示例值:EV-2018022511223320873 |
通知?jiǎng)?chuàng)建時(shí)間 | create_time | string[1,16] | 是 | 通知?jiǎng)?chuàng)建的時(shí)間,格式為yyyyMMddHHmmss(標(biāo)準(zhǔn)iso8601時(shí)間格式) 遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,HH:mm:ss.表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示北京時(shí)間2015年05月20日13點(diǎn)29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
通知類(lèi)型 | event_type | string[1,32] | 是 | 通知的類(lèi)型, 授權(quán)成功通知的類(lèi)型為PAYSCORE.USER_OPEN_SERVICE 解除授權(quán)成功通知的類(lèi)型為PAYSCORE.USER_CLOSE_SERVICE 用戶(hù)確認(rèn)成功通知的類(lèi)型為PAYSCORE.USER_CONFIRM 支付成功通知的類(lèi)型為PAYSCORE.USER_PAID 示例值:PAYSCORE.USER_PAID |
通知數(shù)據(jù)類(lèi)型 | resource_type | string[1,32] | 是 | 通知的資源數(shù)據(jù)類(lèi)型,授權(quán)/解除授權(quán)成功通知為encryptresource 示例值:encrypt-resource |
+通知數(shù)據(jù) | resource | object | 是 | 通知資源數(shù)據(jù) json格式,見(jiàn)示例 |
回調(diào)摘要 | summary | string[1,64] | 是 | 回調(diào)摘要 示例值:支付成功 |
加密不能保證通知請(qǐng)求來(lái)自微信。微信會(huì)對(duì)發(fā)送給商戶(hù)的通知進(jìn)行簽名,并將簽名值放在通知的HTTP頭Wechatpay-Signature。商戶(hù)應(yīng)當(dāng)驗(yàn)證簽名,以確認(rèn)請(qǐng)求來(lái)自微信,而不是其他的第三方。簽名驗(yàn)證的算法請(qǐng)參考 《微信支付API v3簽名驗(yàn)證》。
{
"id":"EV-2018022511223320873",
"create_time":"2015-05-20T13:29:35+08:00",
"resource_type":"encrypt-resource",
"event_type":"PAYSCORE.USER_PAID",
"resource" : {
"algorithm":"AEAD_AES_256_GCM",
"ciphertext": "...",
"nonce": "...",
"associated_data": ""
},
"summary": "支付成功"
}
{
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"out_order_no": "1234323JKHDFE1243252",
"service_id": "500001",
"openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
"state": "DONE",
"total_amount": "40000",
"service_introduction": "嗨客餐廳用餐",
"post_payments": [
{
"name": "服務(wù)費(fèi)",
"amount": 40000,
"description": "每分鐘1元"
}
],
"post_discounts": [
{
"name": "滿(mǎn)20減1元",
"amount": 1,
"description": "不與其他優(yōu)惠疊加"
}
],
"risk_fund": {
"name": "ESTIMATE_ORDER_COST",
"amount": 10000,
"description": "就餐的預(yù)估費(fèi)用"
},
"time_range": {
"start_time": "20091225091010",
"end_time": "20091225091210"
},
"location": {
"start_location": "嗨客時(shí)尚主題展餐廳",
"end_location": "嗨客時(shí)尚主題展餐廳"
},
"attach": "attach",
"notify_url": "https://api.test.com",
"order_id": "165461131",
"need_collection": true,
"collection": {
"state": "USER_PAID",
"total_amount": 40000,
"paying_amount": 40000,
"paid_amount": 0,
"details": [
{
"seq": 1,
"amount": 10000,
"paid_type": "MCH",
"paid_time": "20091225091210",
"transaction_id": "15646546545165651651",
"promotion_detail":[
{
"coupon_id": "123456",
"name": "單品優(yōu)惠-6",
"scope": "GLOBAL",
"type": "CASH",
"amount": 100,
"stock_id": "activity_id",
"wechatpay_contribute": 100,
"merchant_contribute": 100,
"other_contribute": 0,
"currency": "CNY",
"goods_detail": [
{
"goods_id": "M1006",
"quantity": 1,
"unit_price": 1,
"discount_amount": 0,
"goods_remark": "商品備注信息",
}
]
}
]
}
]
}
}
參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
公眾賬號(hào)ID | appid | string[1,32] | 是 | 調(diào)用接口提交的公眾賬號(hào)ID 示例值:wxd678efh567hg6787 |
商戶(hù)號(hào) | mchid | string[1,32] | 是 | 調(diào)用接口提交的商戶(hù)號(hào) 示例值:1230000109 |
商戶(hù)服務(wù)訂單號(hào) | out_order_no | string[1,32] | 是 | 調(diào)用接口提交的商戶(hù)服務(wù)訂單號(hào) 示例值:1234323JKHDFE1243252 |
服務(wù)ID | service_id | string[1,32] | 是 | 調(diào)用該接口提交的服務(wù)ID 示例值:500001 |
用戶(hù)標(biāo)識(shí) | openid | string[1,128] | 是 | 微信用戶(hù)在商戶(hù)對(duì)應(yīng)appid下的唯一標(biāo)識(shí)。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
服務(wù)訂單狀態(tài) | state | string[1,32] | 是 | 表示當(dāng)前單據(jù)狀態(tài)。 1、DONE:服務(wù)訂單完成 示例值:DONE |
訂單狀態(tài)說(shuō)明 | state_description | string[1,32] | 否 | 對(duì)服務(wù)訂單"進(jìn)行中"狀態(tài)的附加說(shuō)明: USER_CONFIRM:用戶(hù)確認(rèn) MCH_COMPLETE:商戶(hù)完結(jié) 示例值:MCH_COMPLETE |
商戶(hù)收款總金額 | total_amount | int64 | 否 | 總金額,大于等于0的數(shù)字,單位為分,只能為整數(shù),詳見(jiàn)支付金額。 此參數(shù)需滿(mǎn)足:總金額=后付費(fèi)項(xiàng)目金額之和-后付費(fèi)商戶(hù)優(yōu)惠項(xiàng)目金額之和,且小于等于訂單風(fēng)險(xiǎn)金額。取消訂單時(shí),該字段必須為0。 示例值:40000 |
服務(wù)信息 | service_introduction | string[1,20] | 是 | 服務(wù)信息,用于介紹本訂單所提供的服務(wù) 不超過(guò)20個(gè)字符,超出報(bào)錯(cuò)處理 示例值:嗨客餐廳用餐 |
+后付費(fèi)項(xiàng)目 | post_payments | array | 是 | 付費(fèi)項(xiàng)目列表,最多包含100條付費(fèi)項(xiàng)目 |
+后付費(fèi)商戶(hù)優(yōu)惠 | post_discounts | array | 否 | 商戶(hù)優(yōu)惠列表,最多包含5條商戶(hù)優(yōu)惠 |
+訂單風(fēng)險(xiǎn)金 | risk_fund | object | 是 | 訂單風(fēng)險(xiǎn)金信息 |
+服務(wù)時(shí)間段 | time_range | object | 是 | 服務(wù)使用時(shí)間范圍 |
+服務(wù)位置 | location | object | 否 | 服務(wù)使用位置信息 |
商戶(hù)數(shù)據(jù)包 | attach | string[1,200] | 否 | 商戶(hù)數(shù)據(jù)包可存放本訂單所需信息,需要先urlencode后傳入。 當(dāng)商戶(hù)數(shù)據(jù)包總長(zhǎng)度超出256字符時(shí),報(bào)錯(cuò)處理。 示例值:attach |
商戶(hù)回調(diào)地址 | notify_url | string[1,255] | 是 | query商戶(hù)接收用戶(hù)確認(rèn)訂單和付款成功回調(diào)通知的地址。 示例值:https://api.test.com |
微信支付服務(wù)訂單號(hào) | order_id | string[1,64] | 否 | 微信支付服務(wù)訂單號(hào),每個(gè)微信支付服務(wù)訂單號(hào)與商戶(hù)號(hào)下對(duì)應(yīng)的商戶(hù)服務(wù)訂單號(hào)一一對(duì)應(yīng) 示例值:15646546545165651651 |
是否需要收款 | need_collection | bool | 否 | 是否需要收款,非0元完結(jié)后返回 true:微信支付分代收款 false:無(wú)需微信支付分代收款 示例值:false |
+收款信息 | collection | object | 否 | 收款信息,非0元完結(jié)后返回 |
商戶(hù)后臺(tái)在正確處理回調(diào)之后,需要返回200或者204的HTTP狀態(tài)碼。其他的狀態(tài)碼,微信支付均認(rèn)為通知失敗,并按照前述的策略定期發(fā)起通知。
注意:當(dāng)商戶(hù)后臺(tái)應(yīng)答失敗時(shí),微信支付將記錄下應(yīng)答的報(bào)文,建議商戶(hù)按照以下格式返回。
參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | code | string[1,32] | 是 | 錯(cuò)誤碼,SUCCESS為接收成功,其他錯(cuò)誤碼為失敗。 示例值:SUCCESS |
返回信息 | message | string[1,256] | 否 | 返回信息,如非空,為錯(cuò)誤原因。 示例值:系統(tǒng)錯(cuò)誤 |
{
"code": "ERROR_NAME",
"message": "ERROR_DESCRIPTION",
}