退款通知API
注意:
? 同樣的通知可能會多次發(fā)送給商戶系統(tǒng)。商戶系統(tǒng)必須能夠正確處理重復(fù)的通知。 推薦的做法是,當(dāng)商戶系統(tǒng)收到通知進行處理時,先檢查對應(yīng)業(yè)務(wù)數(shù)據(jù)的狀態(tài),并判斷該通知是否已經(jīng)處理。如果未處理,則再進行處理;如果已處理,則直接返回結(jié)果成功。在對業(yè)務(wù)數(shù)據(jù)進行狀態(tài)檢查和處理之前,要采用數(shù)據(jù)鎖進行并發(fā)控制,以避免函數(shù)重入造成的數(shù)據(jù)混亂。
? 如果在所有通知頻率(4小時)后沒有收到微信側(cè)回調(diào),商戶應(yīng)調(diào)用查詢訂單接口確認(rèn)訂單狀態(tài)。
特別提醒:機構(gòu)系統(tǒng)對于支付結(jié)果通知的內(nèi)容一定要做簽名驗證,并校驗返回的訂單金額是否與商戶側(cè)的訂單金額一致,防止數(shù)據(jù)泄露導(dǎo)致出現(xiàn)“假通知”,造成資金損失。
1. 接口說明
適用對象:直連模式機構(gòu)模式
請求URL: 商戶自定義。示例:notify_url:http://www.tg885.com/wxpay/123456789。 說明:該鏈接是通過【申請退款A(yù)PI】中提交的參數(shù)notify_url設(shè)置,必須為https協(xié)議。如果鏈接無法訪問,商戶將無法接收到微信通知。必須為直接可訪問的url,不能攜帶參數(shù)。
2. 通知規(guī)則
退款狀態(tài)改變后,微信會把相關(guān)退款結(jié)果發(fā)送給商戶。
對后臺通知交互時,如果微信收到應(yīng)答不是成功或超時,微信認(rèn)為通知失敗,微信會通過一定的策略定期重新發(fā)起通知,盡可能提高通知的成功率,但微信不保證通知最終能成功。 (通知頻率為15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 總計 24h4m)
3. 通知報文
退款結(jié)果通知是以“POST”方法訪問商戶設(shè)置的通知url,通知的數(shù)據(jù)以“JSON”格式通過請求主體(BODY)傳輸。通知的數(shù)據(jù)包括了加密的退款結(jié)果詳情。
下面詳細(xì)描述證書解密的流程
1、從商戶平臺上獲取商戶的密鑰,記為“key”。
2、針對“algorithm”中描述的算法(目前為AEAD_AES_256_GCM),取得對應(yīng)的參數(shù)“nonce”和“associated_data”。
3、使用“key”、“nonce”和“associated_data”對數(shù)據(jù)密文“ciphertext”進行解密(需要先對ciphertext做base64解碼,然后再解密),得到證書內(nèi)容
注意
AEAD_AES_256_GCM算法的接口細(xì)節(jié),請參考rfc5116。微信支付使用的密鑰key長度為32個字節(jié),隨機串nonce長度12個字節(jié),associated_data長度小于16個字節(jié)并可能為空。
4. 通知參數(shù)
參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
通知ID |
id |
string[1,36] |
是 |
通知的唯一ID
示例值:f7c34059-0f2d-5b32-ba33-a42dks0597c5 |
通知創(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] |
是 |
通知的類型,
REFUND.SUCCESS:退款成功通知
REFUND.CLOSED:退款關(guān)閉通知
示例值:REFUND.SUCCESS |
通知數(shù)據(jù)類型 |
resource_type |
string[1,32] |
是 |
通知的資源數(shù)據(jù)類型,支付成功通知為encrypt-resource
示例值:encrypt-resource |
通知簡要說明 |
summary |
string[1,16] |
是 |
通知簡要說明
示例值:退款成功 |
通知數(shù)據(jù) |
resource |
object |
是 |
通知資源數(shù)據(jù) |
參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
加密算法類型 |
algorithm |
string[1,32] |
是 |
對支付結(jié)果數(shù)據(jù)進行加密的加密算法,目前只支持AEAD_AES_256_GCM
示例值:AEAD_AES_256_GCM |
加密前的對象類型 |
original_type |
string[1,32] |
是 |
加密前的對象類型,退款通知的類型為refund
Example: refund |
數(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ā)送給商戶的通知進行簽名,并將簽名值放在通知的HTTP頭Wechatpay-Signature。商戶應(yīng)當(dāng)驗證簽名,以確認(rèn)請求來自微信,而不是其他的第三方。簽名驗證的算法請參考《微信支付API V3簽名驗證》。
6. 回調(diào)示例
退款通知
{
"id": "f7c34059-0f2d-5b32-ba33-a42dks0597c5",
"create_time": "2018-06-08T10:34:56+08:00",
"resource_type": "encrypt-resource",
"event_type": "REFUND.SUCCESS",
"summary": "退款成功",
"resource": {
"original_type": "refund",
"algorithm": "AEAD_AES_256_GCM",
"ciphertext": "...",
"associated_data": "",
"nonce": "..."
}
}
商戶對resource對象進行解密后,得到的資源對象示例
{
"sp_mchid": "1900000100",
"sub_mchid": "1900000109",
"transaction_id": "1008450740201411110005820873",
"out_trade_no": "20150806125346",
"refund_id": "50200207182018070300011301001",
"out_refund_no": "7752501201407033233368018",
"refund_status": "SUCCESS",
"success_time": "2018-06-08T10:34:56+08:00",
"recv_account": "招商銀行信用卡0403",
"fund_source": "REFUND_SOURCE_UNSETTLED_FUNDS",
"amount" : {
"total": 528800,
"currency": "HKD",
"refund": 528800,
"payer_total": 528800,
"payer_refund": 528800,
"payer_currency": "HKD",
"exchange_rate" : {
"type": "SETTLEMENT_RATE",
"rate": 100000000
}
}
}
7. 通知參數(shù)
參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
商戶號 |
mchid |
string[1,32] |
是 |
微信支付分配的商戶號
注意:僅適用于直連模式
示例值:1900000109 |
機構(gòu)商戶號 |
sp_mchid |
string[1,32] |
是 |
微信支付分配的機構(gòu)商戶號
注意:僅適用于機構(gòu)模式
示例值:1900000100 |
子商戶號 |
sub_mchid |
string[1,32] |
是 |
微信支付分配的子商戶商戶號
注意:僅適用于機構(gòu)模式
示例值:1900000109 |
商戶訂單號 |
out_trade_no |
string[1,32] |
是 |
返回的商戶訂單號
示例值:1217752501201407033233368018 |
微信支付訂單號 |
transaction_id |
string[1,32] |
是 |
微信支付訂單號
示例值:1217752501201407033233368018 |
商戶退款單號 |
out_refund_no |
string[1,64] |
是 |
商戶退款單號
示例值:1217752501201407033233368018 |
微信退款單號 |
refund_id |
string[1,32] |
是 |
微信退款單號
示例值:1217752501201407033233368018 |
退款狀態(tài) |
refund_status |
string[1,16] |
是 |
退款狀態(tài):
SUCCESS:退款成功
CLOSED:退款關(guān)閉
ABNORMAL:退款異常,退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了,導(dǎo)致原路退款銀行卡失敗,可前往【服務(wù)商平臺—>交易中心】,手動處理此筆退款
示例值:SUCCESS |
退款成功時間 |
success_time |
string[1,64] |
否 |
退款成功時間,當(dāng)退款狀態(tài)為退款成功時有返回,格式為rfc3339格式
示例值:2018-06-08T10:34:56+08:00 |
退款入賬賬戶 |
recv_account |
string[1,64] |
是 |
取當(dāng)前退款單的退款入賬方
1)退回銀行卡:
{銀行名稱}{卡類型}{卡尾號}
2)退回支付用戶零錢:
支付用戶零錢
3)退還商戶:
商戶基本賬戶
商戶結(jié)算銀行賬戶
4)退回支付用戶零錢通:
支付用戶零錢通
示例值:招商銀行信用卡0403 |
退款資金來源 |
fund_source |
string[1,30] |
否 |
REFUND_SOURCE_UNSETTLED_FUNDS:未結(jié)算資金退款(默認(rèn)使用未結(jié)算資金退款)
REFUND_SOURCE_RECHARGE_FUNDS:可用余額退款
示例值:REFUND_SOURCE_UNSETTLED_FUNDS |
金額信息 |
amount |
object |
是 |
金額信息,詳細(xì)說明見下文 |
參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
訂單金額 |
total |
int |
是 |
訂單總金額,幣種的最小單位,只能為整數(shù)
示例值:888 |
訂單標(biāo)價幣種 |
currency |
string[1,16] |
是 |
符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼
示例值:CNY |
退款金額 |
refund |
int |
是 |
退款金額,幣種的最小單位,只能為整數(shù),不能超過原訂單支付金額,如果有使用券,后臺會按比例退。
示例值:888 |
用戶支付金額 |
payer_total |
int |
是 |
用戶實際支付金額,幣種的最小單位,只能為整數(shù)
示例值:888 |
用戶退款金額 |
payer_refund |
int |
是 |
退款給用戶的金額,不包含優(yōu)惠券金額
示例值:888 |
用戶支付幣種 |
payer_currency |
string[1,16] |
是 |
符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼
示例值:HKD |
匯率信息 |
exchange_rate |
object |
否 |
匯率信息對象,詳細(xì)說明見下文 |
參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
匯率類型 |
type |
string[1,16] |
否 |
標(biāo)價幣種和支付幣種一致時,type="SETTLEMENT_RATE",即【實時】標(biāo)價幣種和結(jié)算幣種的匯率;
標(biāo)價幣種和支付幣種不一致,type="USERPAYMENT_RATE",即【原支付】標(biāo)價幣種和支付幣種的匯率
示例值:SETTLEMENT_RATE |
匯率值 |
rate |
int |
否 |
rate值是兌換比例乘以10的8次方,
如果兌換比例是1,則rate=100000000;
如果兌換比例為6.5,則rate=650000000
示例值:80000000 |
|
|
8. 通知應(yīng)答
參數(shù)名 |
變量 |
類型[長度限制] |
必填 |
描述 |
返回狀態(tài)碼 |
code |
string[1,32] |
是 |
詳見下面返回狀態(tài)碼說明
示例值:SUCCESS |
返回信息 |
message |
string[1,256] |
否 |
返回信息,為錯誤原因
示例值:系統(tǒng)錯誤 |
{
"code": "SYSTEM_ERROR",
"message": "處理成功"
}