退款结果通知

更新时间：2024.11.18

退款状态改变后，微信会把相关退款结果发送给商户。

注意

对后台通知交互时，如果微信收到应答不是成功或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。
同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。推荐的做法是，当商户系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理。如果未处理，则再进行处理；如果已处理，则直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。
如果在所有通知频率后没有收到微信侧回调。商户应调用查询订单接口确认订单状态。

特别提醒：商户系统对于开启结果通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现“假通知”，造成资金损失。

接口说明

支持商户：【平台商户】

请求方式：【POST】

请求URL：该链接是通过【商户配置】提交service_notify_url设置，必须为HTTPS协议。如果链接无法访问，商户将无法接收到微信通知。通知URL必须为直接可访问的URL，不能携带参数。示例："https://pay.weixin.qq.com/wxpay/pay.action"。

通知规则

用户退款完成后，微信会把相关退款结果和用户信息发送给清算机构，清算机构需要接收处理后返回应答成功，然后继续给异步通知到下游从业机构。

对后台通知交互时，如果微信收到应答不是成功或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m）

通知报文

退款结果通知是以POST 方法访问商户设置的通知URL，通知的数据以JSON 格式通过请求主体（BODY）传输。通知的数据包括了加密的退款结果详情。

注意

由于涉及到回调加密和解密，商户必须先设置好APIv3密钥后才能解密回调通知，APIv3密钥设置文档指引详见APIv3密钥设置指引

步骤说明

步骤一：验证签名

微信支付会对发送给商户的通知进行签名，并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名，以确认请求来自微信，而不是其他的第三方。签名验证的算法请参考《微信支付API v3签名验证》。

步骤二：参数解密

为了保证安全性，微信支付在回调通知，对关键信息进行了AES-256-GCM加密。商户应当按照以下的流程进行解密关键信息，解密的流程：

用商户平台上设置的APIv3密钥【微信服务商平台—>账户设置—>API安全—>设置APIv3密钥】，记为key；
获取resource.algorithm中描述的算法（目前为AEAD_AES_256_GCM），以及resource.nonce和resource.associated_data；
使用key、nonce和associated_data，对数据密文resource.ciphertext进行解密，得到JSON形式的资源对象。

注意

AEAD_AES_256_GCM算法的接口细节，请参考rfc5116。微信支付使用的密钥key长度为32个字节，随机串nonce长度12个字节，associated_data长度小于16个字节并可能为空。
Java回调解密Json取值不带引号。

字段说明

通知参数

Body 包体参数

id 必填 string(36)
通知的唯一ID。

create_time 必填 string(32)

通知创建的时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日13点29分35秒。

event_type 必填 string(32)

通知的类型：
REFUND.SUCCESS：退款成功通知
REFUND.ABNORMAL：退款异常通知
REFUND.CLOSED：退款关闭通知

summary 必填 string(16)

通知简要说明

resource_type 必填 string(32)

通知的资源数据类型，退款成功通知为encrypt-resource

resource 必填 object
通知资源数据
json格式，见示例

属性

algorithm 必填 string(32)
对开启结果数据进行加密的加密算法，目前只支持AEAD_AES_256_GCM

original_type 必填 string(32)

加密前的对象类型，退款通知的类型为refund

ciphertext 必填 string(1048576)
Base64编码后的开启/停用结果数据密文

associated_data 选填 string(16)
附加数据

nonce 必填 string(16)
加密使用的随机串

退款通知

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2018-06-08T10:34:56+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"REFUND.SUCCESS",
6  "summary":"退款成功",
7    "resource" : {
8        "algorithm":"AEAD_AES_256_GCM",
9    "original_type": "refund",
10        "ciphertext": "...",
11        "nonce": "...",
12        "associated_data": ""
13    }
14}

resource解密后字段

Body 包体参数

sp_mchid 必填 string(32)

微信支付分配给电商平台的商户号

sub_mchid 必填 string(32)

微信支付分配给二级商户的商户号

out_trade_no 必填 string(32)

返回的商户订单号

transaction_id 必填 string(32)

微信支付订单号

out_refund_no 必填 string(64)

商户退款单号

refund_id 必填 string(32)

微信退款单号

refund_status 必填 string(32)

退款状态，枚举值：
SUCCESS：退款成功
CLOSE：退款关闭
ABNORMAL：退款异常，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，可前往【服务商平台—>交易中心】，手动处理此笔退款

success_time 选填 string(64)

1、退款成功时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日13点29分35秒。
2、当退款状态为退款成功时返回此参数。

user_received_account 必填 string(64)

取当前退款单的退款入账方。
退回银行卡：{银行名称}{卡类型}{卡尾号}
退回支付用户零钱: 支付用户零钱
退还商户: 商户基本账户、商户结算银行账户
退回支付用户零钱通：支付用户零钱通
退回用户经营账户：用户经营账户
退回支付用户银行电子账户：支付用户银行电子账户
退回支付用户零花钱：支付用户零花钱
退回支付用户来华零钱包：支付用户来华零钱包
退回企业支付商户：企业支付商户

amount 必填 object

金额信息

属性

total 必填 int

订单总金额，单位为分，只能为整数，详见支付金额

refund 必填 int

退款金额，币种的最小单位，只能为整数，不能超过原订单支付金额，如果有使用券，后台会按比例退

payer_total 必填 int

用户实际支付金额，单位为分，只能为整数，详见支付金额

payer_refund 必填 int

退款给用户的金额，不包含所有优惠券金额

refund_account 选填 string(32)

电商平台垫资退款专用参数。需先确认已开通此功能后，才能使用。若需要开通，请联系微信支付客服。
枚举值：
REFUND_SOURCE_PARTNER_ADVANCE : 电商平台垫付，需要向微信支付申请开通
REFUND_SOURCE_SUB_MERCHANT : 二级商户，默认值
注意：若传入REFUND_SOURCE_PARTNER_ADVANCE，仅代表可以使用垫付退款，实际出款账户需以退款申请受理结果或查单结果为准。

对resource对象进行解密后，得到的资源对象示例

1{
2    "sp_mchid": "1900000100",
3    "sub_mchid": "1900000109",
4    "transaction_id": "1008450740201411110005820873",
5    "out_trade_no": "20150806125346",
6    "refund_id": "50200207182018070300011301001",
7    "out_refund_no": "7752501201407033233368018",
8    "refund_status": "SUCCESS",
9    "success_time": "2018-06-08T10:34:56+08:00",
10    "user_received_account": "招商银行信用卡0403",
11    "amount" : {
12        "total": 999,
13        "refund": 999,
14        "payer_total": 999,
15        "payer_refund": 999
16    },
17    "refund_account": "REFUND_SOURCE_SUB_MERCHANT"
18}

通知应答

接收成功： HTTP应答状态码需返回200或204，无需返回应答报文。

接收失败： HTTP应答状态码需返回5XX或4XX，同时需返回应答报文，格式如下：

Body 包体参数

code 必填 string(32)

【返回状态码】
错误码，SUCCESS为清算机构接收成功，其他错误码为失败。

message 选填 string(256)

【返回信息】
返回信息，如非空，为错误原因。

应答示例

1{  
2    "code": "FAIL",
3    "message": "失败"
4}

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服