支付結(jié)果通知API
最新更新時(shí)間：2023.10.19
版本說明
注意：
? 只有支付成功的訂單才會(huì)推送支付結(jié)果通知，其他情況均不會(huì)通知。
? 同樣的通知可能會(huì)多次發(fā)送給商戶系統(tǒng)。商戶系統(tǒng)必須能夠正確處理重復(fù)的通知。 推薦的做法是，當(dāng)商戶系統(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ù)混亂。
? 如果在所有通知頻率(4小時(shí))后沒有收到微信側(cè)回調(diào)，商戶應(yīng)調(diào)用查詢訂單接口確認(rèn)訂單狀態(tài)。
特別提醒：機(jī)構(gòu)系統(tǒng)對(duì)于支付結(jié)果通知的內(nèi)容一定要做簽名驗(yàn)證,并校驗(yàn)返回的訂單金額是否與商戶側(cè)的訂單金額一致，防止數(shù)據(jù)泄露導(dǎo)致出現(xiàn)“假通知”，造成資金損失。
1. 接口說明
適用對(duì)象:直連模式機(jī)構(gòu)模式
請(qǐng)求URL: 商戶自定義。示例：notify_url：http://www.tg885.com/wxpay/123456789。 說明：該鏈接是通過【下單API】中提交的參數(shù)notify_url設(shè)置，必須為https協(xié)議。如果鏈接無法訪問，商戶將無法接收到微信通知。必須為直接可訪問的url，不能攜帶參數(shù)。
2. 通知規(guī)則
用戶支付完成后，微信會(huì)把相關(guān)支付結(jié)果和用戶信息發(fā)送給商戶，商戶需要接收處理后返回應(yīng)答成功。只有支付成功才會(huì)通知。
對(duì)后臺(tái)通知交互時(shí)，如果微信收到應(yīng)答不是成功或超時(shí)，微信認(rèn)為通知失敗，微信會(huì)通過一定的策略定期重新發(fā)起通知，盡可能提高通知的成功率，但微信不保證通知最終能成功。 （通知頻率為15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 總計(jì) 24h4m）處理重復(fù)的通知。
3. 通知報(bào)文
支付結(jié)果通知是以“POST”方法訪問商戶設(shè)置的通知url，通知的數(shù)據(jù)以“JSON”格式通過請(qǐng)求主體（BODY）傳輸。通知的數(shù)據(jù)包括了加密的支付結(jié)果詳情。
下面詳細(xì)描述證書解密的流程
1、從商戶平臺(tái)上獲取商戶的密鑰，記為“key”。
2、針對(duì)“algorithm”中描述的算法（目前為AEAD_AES_256_GCM），取得對(duì)應(yīng)的參數(shù)“nonce”和“associated_data”。
3、使用“key”、“nonce”和“associated_data”對(duì)數(shù)據(jù)密文“ciphertext”進(jìn)行解密（需要先對(duì)ciphertext做base64解碼，然后再解密），得到證書內(nèi)容
注意
AEAD_AES_256_GCM算法的接口細(xì)節(jié)，請(qǐng)參考rfc5116。微信支付使用的密鑰key長(zhǎng)度為32個(gè)字節(jié)，隨機(jī)串nonce長(zhǎng)度12個(gè)字節(jié)，associated_data長(zhǎng)度小于16個(gè)字節(jié)并可能為空。
4. 通知參數(shù)
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 通知ID |
id |
string[1,36] |
是 |
通知的唯一ID
示例值：f7c34059-0f2d-5b32-ba33-a42dks0597c5 |
| 通知?jiǎng)?chuàng)建時(shí)間 |
create_time |
string[1,64] |
是 |
通知?jiǎng)?chuàng)建的時(shí)間，格式為rfc3339格式，如2018-06-08T10:34:56+08:00?代表北京時(shí)間2018年06月08日10時(shí)34分56秒
示例值：2018-06-08T10:34:56+08:00 |
| 通知類型 |
event_type |
string[1,32] |
是 |
通知的類型，支付成功通知的類型為TRANSACTION.SUCCESS
示例值：TRANSACTION.SUCCESS |
| 通知數(shù)據(jù)類型 |
resource_type |
string[1,32] |
是 |
通知的資源數(shù)據(jù)類型，支付成功通知為encrypt-resource
示例值：encrypt-resource |
| 通知簡(jiǎn)要說明 |
summary |
string[1,16] |
是 |
通知簡(jiǎn)要說明
示例值：支付成功 |
| 通知數(shù)據(jù) |
resource |
object |
是 |
通知資源數(shù)據(jù) |
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 加密算法類型 |
algorithm |
string[1,32] |
是 |
對(duì)支付結(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ù) |
| 隨機(jī)串 |
nonce |
string[1,32] |
是 |
加密使用的隨機(jī)串 |
|
5. 通知簽名
加密不能保證通知請(qǐng)求來自微信。微信會(huì)對(duì)發(fā)送給商戶的通知進(jìn)行簽名，并將簽名值放在通知的HTTP頭Wechatpay-Signature。商戶應(yīng)當(dāng)驗(yàn)證簽名，以確認(rèn)請(qǐng)求來自微信，而不是其他的第三方。簽名驗(yàn)證的算法請(qǐng)參考《微信支付API V3簽名驗(yàn)證》。
6. 回調(diào)示例
支付成功結(jié)果通知
{
"id": "f7c34059-0f2d-5b32-ba33-a42dks0597c5",
"create_time": "2018-06-08T10:34:56+08:00",
"resource_type": "encrypt-resource",
"event_type":"TRANSACTION.SUCCESS",
"summary": "支付成功",
"resource": {
"algorithm": "AEAD_AES_256_GCM",
"ciphertext": "...",
"associated_data": "",
"nonce": "..."
}
}
商戶對(duì)resource對(duì)象進(jìn)行解密后，得到的資源對(duì)象示例
{
"id": "1008450740201411110005820873",
"sp_appid": "wx2421b1c4370ec43b",
"sp_mchid": "10000100",
"sub_mchid": "20000100",
"out_trade_no": "20150806125346",
"payer": {
"sp_openid": "oUpF8uN95-Ptaags6E_roPHg7AG0"
},
"amount": {
"total": 528800,
"currency": "HKD",
"payer_total": 518799,
"payer_currency": "CNY",
"exchange_rate": {
"type": "SETTLEMENT_RATE",
"rate": 8000000
}
},
"trade_type": "MICROPAY",
"trade_state": "SUCCESS",
"trade_state_desc": "支付成功",
"bank_type": "CCB_DEBIT",
"attach": "支付測(cè)試",
"success_time": "2018-06-08T10:34:56+08:00",
"promotion_detail": [{
"promotion_id": "109519",
"name": "單品惠-6",
"scope": "SINGLE",
"type": "DISCOUNT",
"amount": 1,
"currency": "HKD",
"activity_id": "931386",
"wechatpay_contribute_amount": 1,
"merchant_contribute_amount": 0,
"other_contribute_amount": 0,
"goods_detail": [{
"goods_id": "iphone6s_16G",
"goods_remark": "商品備注",
"quantity": 1,
"price": 528800
}]
}]
}
7. 通知參數(shù)
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 商戶號(hào) |
mchid |
string[1, 32] |
是 |
微信支付分配的商戶號(hào)
注意：僅適用于直連模式
示例值：1900000109 |
| APPID |
appid |
string[1, 32] |
是 |
商戶在微信公眾平臺(tái)申請(qǐng)服務(wù)號(hào)對(duì)應(yīng)的APPID
注意：僅適用于直連模式
示例值：wx8888888888888888 |
| 機(jī)構(gòu)商戶號(hào) |
sp_mchid |
string[1, 32] |
是 |
微信支付分配的機(jī)構(gòu)商戶號(hào)
注意：僅適用于機(jī)構(gòu)模式
示例值：1900000100 |
| 子商戶號(hào) |
sub_mchid |
string[1, 32] |
是 |
微信支付分配的子商戶號(hào)
注意：僅適用于機(jī)構(gòu)模式
示例值：1900000109 |
| 機(jī)構(gòu)APPID |
sp_appid |
string[1, 32] |
是 |
機(jī)構(gòu)在微信公眾平臺(tái)申請(qǐng)服務(wù)號(hào)對(duì)應(yīng)的APPID
注意：僅適用于機(jī)構(gòu)模式
示例值：wx8888888888888888 |
| 子商戶APPID |
sub_appid |
string[1, 32] |
否 |
子商戶在微信開放平臺(tái)申請(qǐng)移動(dòng)應(yīng)用對(duì)應(yīng)的APPID
注意：僅適用于機(jī)構(gòu)模式
示例值：wx8888888888888888 |
| 商戶訂單號(hào) |
out_trade_no |
string[1, 32] |
是 |
返回的商戶訂單號(hào)
示例值：1217752501201407033233368018 |
| 微信支付訂單號(hào) |
id |
string[1, 32] |
是 |
微信支付訂單號(hào)
示例值：4200000000002104083200000488 |
| 商戶數(shù)據(jù) |
attach |
string[1, 127] |
否 |
附加數(shù)據(jù)，在查詢API和支付通知中原樣返回，該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù)
示例值：自定義數(shù)據(jù) |
| 交易類型 |
trade_type |
string[1, 16] |
是 |
APP支付
示例值：APP |
| 付款銀行 |
bank_type |
string[1, 32] |
是 |
銀行類型，采用字符串類型的銀行標(biāo)識(shí)，值列表詳見銀行類型
示例值：CMC |
| 支付完成時(shí)間 |
success_time |
string[1, 64] |
是 |
訂單支付成功時(shí)間，格式為rfc3339格式，如2018-06-08T10:34:56+08:00?代表北京時(shí)間2018年06月08日10時(shí)34分56秒
示例值：2018-06-08T10:34:56+08:00 |
| 交易狀態(tài) |
trade_state |
string[1, 32] |
是 |
SUCCESS：支付成功
注意：只有支付成功的訂單才會(huì)推送支付結(jié)果通知，因此該字段的返回均為SUCCESS
示例值：SUCCESS |
| 交易狀態(tài)描述 |
trade_state_desc |
string[1, 256] |
是 |
對(duì)當(dāng)前訂單狀態(tài)的描述和下一步操作的指引
示例值：支付失敗，請(qǐng)重新下單支付 |
| 支付者 |
payer |
object |
是 |
支付者信息，詳細(xì)說明見下文 |
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 用戶標(biāo)識(shí) |
openid |
string[1, 128] |
否 |
用戶在商戶appid對(duì)應(yīng)下的唯一標(biāo)識(shí)，需要傳appid才有返回
注意：僅適用于直連模式
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
| 用戶標(biāo)識(shí)（機(jī)構(gòu)） |
sp_openid |
string[1, 128] |
否 |
用戶在機(jī)構(gòu)sp_appid對(duì)應(yīng)下的唯一標(biāo)識(shí)，openid和sub_openid可以選傳其中之一，如果選擇傳sub_openid,則必須傳sub_appid。下單前需要調(diào)用【網(wǎng)頁授權(quán)】接口獲取到用戶的openid。
注意：僅適用于機(jī)構(gòu)模式
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
| 用戶標(biāo)識(shí)（子商戶） |
sub_openid |
string[1, 128] |
否 |
用戶在子商戶sub_appid下用戶唯一標(biāo)識(shí)，openid和sub_openid可以選傳其中之一，如果選擇傳sub_openid,則必須傳sub_appid。下單前需要調(diào)用【網(wǎng)頁授權(quán)】接口獲取到用戶的openid，
注意：僅適用于機(jī)構(gòu)模式
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
|
| 訂單金額 |
amount |
object |
是 |
訂單金額信息，詳細(xì)說明見下文 |
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 訂單金額 |
total |
int |
是 |
訂單總金額，幣種的最小單位，只能為整數(shù)，詳見交易金額
注意：僅適用于直連模式
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
| 貨幣類型 |
currency |
string[1, 16] |
否 |
符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼。
示例值：CNY |
| 用戶支付金額 |
payer_total |
int |
是 |
用戶實(shí)際支付金額，幣種的最小單位，只能為整數(shù)，詳見交易金額
示例值：888 |
| 支付貨幣類型 |
payer_currency |
string[1, 16] |
否 |
符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼
示例值：888 |
| 匯率 |
exchange_rate |
object |
否 |
匯率信息 |
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 匯率類型 |
type |
string[1, 16] |
否 |
SETTLEMENT_RATE,即標(biāo)價(jià)幣種和結(jié)算幣種的匯率
示例值：SETTLEMENT_RATE |
| 匯率值 |
rate |
int |
否 |
rate值是兌換比例乘以10的8次方。
如果標(biāo)價(jià)幣種和結(jié)算幣種一致，兌換比例是1，則rate=100000000；
如果標(biāo)價(jià)幣種和結(jié)算幣種不一致，例如美元兌換人民幣的比例為6.5，則rate=650000000
示例值：80000000 |
|
|
| 優(yōu)惠功能 |
promotion_detail |
array |
否 |
優(yōu)惠功能信息，詳細(xì)說明見下文 |
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 券ID |
promotion_id |
string[1, 32] |
是 |
券或者立減優(yōu)惠id
示例值：109519 |
| 優(yōu)惠名稱 |
name |
string[1, 64] |
否 |
優(yōu)惠名稱
示例值：?jiǎn)纹坊?6 |
| 優(yōu)惠范圍 |
scope |
string[1, 32] |
否 |
GLOBAL：全場(chǎng)代金券
SINGLE：?jiǎn)纹穬?yōu)惠
示例值：SINGLE |
| 優(yōu)惠類型 |
type |
string[1, 32] |
否 |
COUPON- 代金券，需要走結(jié)算資金的充值型代金券,（境外商戶券幣種與支付幣種一致）
DISCOUNT- 優(yōu)惠券，不走結(jié)算資金的免充值型優(yōu)惠券，（境外商戶券幣種與標(biāo)價(jià)幣種一致
示例值：DISCOUNT |
| 優(yōu)惠券面額 |
amount |
int |
是 |
用戶享受優(yōu)惠的金額
示例值：5 |
| 貨幣類型 |
currency |
string[1, 16] |
否 |
符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼
示例值：CNY |
| 活動(dòng)ID |
activity_id |
string[1, 32] |
否 |
在微信商戶后臺(tái)配置的批次ID
示例值：931386 |
| 微信出資 |
wechatpay_contribute_amount |
int |
否 |
特指由微信支付商戶平臺(tái)創(chuàng)建的優(yōu)惠，出資金額等于本項(xiàng)優(yōu)惠總金額
示例值：0 |
| 商戶出資 |
merchant_contribute_amount |
int |
否 |
特指商戶自己創(chuàng)建的優(yōu)惠，出資金額等于本項(xiàng)優(yōu)惠總金額
示例值：0 |
| 其他出資 |
other_contribute_amount |
int |
否 |
其他出資方出資金額
示例值：5 |
| 單品列表 |
goods_detail |
Array |
否 |
單品信息，使用Json格式 |
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 商品編碼 |
goods_id |
string[1, 32] |
是 |
由半角的大小寫字母、數(shù)字、中劃線、下劃線中的一種或幾種組成
示例值：12345 |
| 商品備注 |
goods_remark |
string[1, 128] |
否 |
goods_remark為備注字段，按照配置原樣返回，字段內(nèi)容在微信后臺(tái)配置券時(shí)進(jìn)行設(shè)置。
示例值：1001 |
| 商品優(yōu)惠金額 |
discount_amount |
int |
是 |
單品的總優(yōu)惠金額
示例值：100 |
| 商品數(shù)量 |
quantity |
int |
是 |
用戶購(gòu)買的數(shù)量
示例值：1 |
| 商品價(jià)格 |
price |
int |
是 |
單位為：分。如果商戶有優(yōu)惠，需傳輸商戶優(yōu)惠后的單價(jià)(例如：用戶對(duì)一筆100元的訂單使用了商場(chǎng)發(fā)的紙質(zhì)優(yōu)惠券100-50，則活動(dòng)商品的單價(jià)應(yīng)為原單價(jià)-50)
示例值：528800 |
|
|
8. 通知應(yīng)答
接收成功：HTTP應(yīng)答狀態(tài)碼需返回200或204，無需返回應(yīng)答報(bào)文。
接收失敗：HTTP應(yīng)答狀態(tài)碼需返回5XX或4XX，同時(shí)需返回應(yīng)答報(bào)文，格式如下：
| 參數(shù)名 |
變量 |
類型[長(zhǎng)度限制] |
必填 |
描述 |
| 返回狀態(tài)碼 |
code |
string[1,32] |
是 |
詳見下面返回狀態(tài)碼說明
示例值：SUCCESS |
| 返回信息 |
message |
string[1,256] |
否 |
返回信息，為錯(cuò)誤原因
示例值：系統(tǒng)錯(cuò)誤 |
200
{
"code": "SUCCESS",
"message": "OK"
}
{
"code": "SYSTEM_ERROR",
"message": "系統(tǒng)失敗"
}
