退款通知API
注意:
• 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是,当商户系统收到通知进行处理时,先检查对应业务数据的状态,并判断该通知是否已经处理。如果未处理,则再进行处理;如果已处理,则直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
• 如果在所有通知频率(4小时)后没有收到微信侧回调,商户应调用查询订单接口确认订单状态。
特别提醒:机构系统对于支付结果通知的内容一定要做签名验证,并校验返回的订单金额是否与商户侧的订单金额一致,防止数据泄露导致出现“假通知”,造成资金损失。
1. 接口说明
适用对象:直连模式机构模式
请求URL: 商户自定义。示例:notify_url:https://pay.weixin.qq.com/wxpay/123456789。 说明:该链接是通过【申请退款API】中提交的参数notify_url设置,必须为https协议。如果链接无法访问,商户将无法接收到微信通知。必须为直接可访问的url,不能携带参数。
2. 通知规则
退款状态改变后,微信会把相关退款结果发送给商户。
对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。 (通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m)
3. 通知报文
退款结果通知是以“POST”方法访问商户设置的通知url,通知的数据以“JSON”格式通过请求主体(BODY)传输。通知的数据包括了加密的退款结果详情。
下面详细描述证书解密的流程
1、从商户平台上获取商户的密钥,记为“key”。
2、针对“algorithm”中描述的算法(目前为AEAD_AES_256_GCM),取得对应的参数“nonce”和“associated_data”。
3、使用“key”、“nonce”和“associated_data”对数据密文“ciphertext”进行解密(需要先对ciphertext做base64解码,然后再解密),得到证书内容
注意
AEAD_AES_256_GCM算法的接口细节,请参考rfc5116。微信支付使用的密钥key长度为32个字节,随机串nonce长度12个字节,associated_data长度小于16个字节并可能为空。
4. 通知参数
参数名 |
变量 |
类型[长度限制] |
必填 |
描述 |
通知ID |
id |
string[1,36] |
是 |
通知的唯一ID
示例值:f7c34059-0f2d-5b32-ba33-a42dks0597c5 |
通知创建时间 |
create_time |
string[1,64] |
是 |
通知创建的时间,格式为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:退款关闭通知
示例值:REFUND.SUCCESS |
通知数据类型 |
resource_type |
string[1,32] |
是 |
通知的资源数据类型,支付成功通知为encrypt-resource
示例值:encrypt-resource |
通知简要说明 |
summary |
string[1,16] |
是 |
通知简要说明
示例值:退款成功 |
通知数据 |
resource |
object |
是 |
通知资源数据 |
参数名 |
变量 |
类型[长度限制] |
必填 |
描述 |
加密算法类型 |
algorithm |
string[1,32] |
是 |
对支付结果数据进行加密的加密算法,目前只支持AEAD_AES_256_GCM
示例值:AEAD_AES_256_GCM |
加密前的对象类型 |
original_type |
string[1,32] |
是 |
加密前的对象类型,退款通知的类型为refund
Example: refund |
数据密文 |
ciphertext |
string[1,1048576] |
是 |
Base64编码后的支付结果数据密文 |
附加数据 |
associated_data |
string[1,16] |
否 |
加密使用的附加数据 |
随机串 |
nonce |
string[1,32] |
是 |
加密使用的随机串 |
|
5. 通知签名
加密不能保证通知请求来自微信。微信会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考《微信支付API V3签名验证》。
6. 回调示例
退款通知
{
"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. 通知参数
参数名 |
变量 |
类型[长度限制] |
必填 |
描述 |
商户号 |
mchid |
string[1,32] |
是 |
微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109 |
机构商户号 |
sp_mchid |
string[1,32] |
是 |
微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000100 |
子商户号 |
sub_mchid |
string[1,32] |
是 |
微信支付分配的子商户商户号
注意:仅适用于机构模式
示例值: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 |
退款状态 |
refund_status |
string[1,16] |
是 |
退款状态:
SUCCESS:退款成功
CLOSED:退款关闭
ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【服务商平台—>交易中心】,手动处理此笔退款
示例值:SUCCESS |
退款成功时间 |
success_time |
string[1,64] |
否 |
退款成功时间,当退款状态为退款成功时有返回,格式为rfc3339格式
示例值:2018-06-08T10:34:56+08:00 |
退款入账账户 |
recv_account |
string[1,64] |
是 |
取当前退款单的退款入账方
1)退回银行卡:
{银行名称}{卡类型}{卡尾号}
2)退回支付用户零钱:
支付用户零钱
3)退还商户:
商户基本账户
商户结算银行账户
4)退回支付用户零钱通:
支付用户零钱通
示例值:招商银行信用卡0403 |
退款资金来源 |
fund_source |
string[1,30] |
否 |
REFUND_SOURCE_UNSETTLED_FUNDS:未结算资金退款(默认使用未结算资金退款)
REFUND_SOURCE_RECHARGE_FUNDS:可用余额退款
示例值:REFUND_SOURCE_UNSETTLED_FUNDS |
金额信息 |
amount |
object |
是 |
金额信息,详细说明见下文 |
参数名 |
变量 |
类型[长度限制] |
必填 |
描述 |
订单金额 |
total |
int |
是 |
订单总金额,币种的最小单位,只能为整数
示例值:888 |
订单标价币种 |
currency |
string[1,16] |
是 |
符合ISO 4217标准的三位字母代码
示例值:CNY |
退款金额 |
refund |
int |
是 |
退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额,如果有使用券,后台会按比例退。
示例值:888 |
用户支付金额 |
payer_total |
int |
是 |
用户实际支付金额,币种的最小单位,只能为整数
示例值:888 |
用户退款金额 |
payer_refund |
int |
是 |
退款给用户的金额,不包含优惠券金额
示例值:888 |
用户支付币种 |
payer_currency |
string[1,16] |
是 |
符合ISO 4217标准的三位字母代码
示例值:HKD |
汇率信息 |
exchange_rate |
object |
否 |
汇率信息对象,详细说明见下文 |
参数名 |
变量 |
类型[长度限制] |
必填 |
描述 |
汇率类型 |
type |
string[1,16] |
否 |
标价币种和支付币种一致时,type="SETTLEMENT_RATE",即【实时】标价币种和结算币种的汇率;
标价币种和支付币种不一致,type="USERPAYMENT_RATE",即【原支付】标价币种和支付币种的汇率
示例值:SETTLEMENT_RATE |
汇率值 |
rate |
int |
否 |
rate值是兑换比例乘以10的8次方,
如果兑换比例是1,则rate=100000000;
如果兑换比例为6.5,则rate=650000000
示例值:80000000 |
|
|
8. 通知应答
参数名 |
变量 |
类型[长度限制] |
必填 |
描述 |
返回状态码 |
code |
string[1,32] |
是 |
详见下面返回状态码说明
示例值:SUCCESS |
返回信息 |
message |
string[1,256] |
否 |
返回信息,为错误原因
示例值:系统错误 |
{
"code": "SYSTEM_ERROR",
"message": "处理成功"
}