申请退款（押金）

更新时间：2024.11.18

应用场景

在押金已消费的情况下，部分金额已结算给商户的资金退还给用户，并为用户下发“退款发起提醒通知“；退款到账后，下发“押金退还到账通知”。可调用多次，允许部分退款。

注意

交易时间超过一年的订单无法提交退款；
退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。一笔退款失败后重新提交，请不要更换退款单号，请使用原商户退款单号。更换退款单号导致多次退款责任由商户承担；
请求频率限制：150qps，即每秒钟正常的申请退款请求次数不超过150次；错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款申请请求不超过6次；
每个支付订单的部分退款次数不能超过50次。

接口规则

请求Url	https://api.mch.weixin.qq.com/deposit/refund
是否需要证书	是，详见证书使用
请求方式	post
签名方式	HMAC-SHA256

请求参数

名称	变量名	必填	类型	示例值	描述
服务商应用ID	appid	是	String(32)	wx8888888888888888	服务商商户的APPID
商户号	mch_id	是	String(32)	1900000109	服务商商户的商户号
子商户应用ID	sub_appid	否	String(32)	wx8888888888888888	微信分配的子商户APPID，如需在支付完成后获取sub_openid则此参数必传。
子商户号	sub_mch_id	是	String(32)	1900000109	服务商通过进件后获得的特约商户号
随机字符串	nonce_str	是	String(32)	5K8264ILTKCH16CQ2502SI8ZNMTM67VS	随机字符串，不长于32位。推荐随机数生成算法
签名	sign	是	String(32)	C370BEC2BFD727A4B6845133519F3AD6	签名，详见签名生成算法
签名类型	sign_type	是	String(32)	HMAC-SHA256	签名类型，仅支持HMAC-SHA256
微信支付订单号	transaction_id	是	String(32)	1217752501201407033233367018	微信支付订单号
押金退款单号	out_refund_no	是	String(64)	1217752501201407033233367018	商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-\|*@ ，同一退款单号多次请求只退一笔。
订单金额	total_fee	是	int	100	订单总金额，单位为分，只能为整数，详见支付金额
申请退款金额	refund_fee	是	int	100	退款总金额，单位为分，只能为整数，可部分退款。详见支付金额
退款货币种类	refund_fee_type	否	String(8)	CNY	退款货币类型，需与支付一致，或者不填。符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
退款原因	refund_desc	否	String(70)	商品已售完	若商户传入，会在下发给用户的退款消息中体现退款原因
退款资金来源	refund_account	否	String(30)	REFUND_SOURCE_RECHARGE_FUNDS	仅针对老资金流商户使用 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款（默认使用未结算资金退款） REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款

举例如下：

1<xml>
2  <appid>wx2421b1c4370ec43b</appid>
3  <mch_id>10000100</mch_id>
4  <nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
5  <sub_mch_id>1415701182</sub_mch_id>
6  <out_refund_no>1415701182</out_refund_no>
7  <out_trade_no>1415757673</out_trade_no>
8  <refund_fee>1</refund_fee>
9  <total_fee>1</total_fee>
10  <transaction_id>4006252001201705123297353072</transaction_id>
11  <sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
12  <sign_type> HMAC-SHA256</sign_type>
13</xml>

返回结果

名称	变量名	必填	类型	示例值	描述
返回状态码	return_code	是	String(16)	SUCCESS	SUCCESS/FAIL
返回信息	return_msg	否	String(128)	签名失败	返回信息，如非空，为错误原因签名失败参数格式校验错误

以下字段在return_code为SUCCESS的时候有返回：

名称	变量名	必填	类型	示例值	描述
业务结果	result_code	是	String(16)	SUCCESS	SUCCESS/FAIL SUCCESS退款申请接收成功，结果通过退款查询接口查询 FAIL 提交业务失败
错误代码	err_code	否	String(32)	SYSTEMERROR	列表详见第6节
错误代码描述	err_code_des	否	String(128)	系统超时	结果信息描述
服务商应用ID	appid	是	String(32)	wx8888888888888888	服务商商户的APPID
商户号	mch_id	是	String(32)	1900000109	服务商商户的商户号
子商户应用ID	sub_appid	否	String(32)	wx8888888888888888	微信分配的子商户APPID，如需在支付完成后获取sub_openid则此参数必传。
子商户号	sub_mch_id	是	String(32)	1900000109	服务商通过进件后获得的特约商户号
随机字符串	nonce_str	是	String(32)	5K8264ILTKCH16CQ2502SI8ZNMTM67VS	随机字符串，不长于32位
签名	sign	是	String(32)	5K8264ILTKCH16CQ2502SI8ZNMTM67VS	签名，详见签名算法
微信订单号	transaction_id	是	String(32)	1217752501201407033233368018	微信订单号
商户订单号	out_trade_no	是	String(32)	1217752501201407033233368018	商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-\|*@ ，且在同一个商户号下唯一。
商户退款单号	out_refund_no	是	String(64)	1217752501201407033233368018	商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-\|*@ ，同一退款单号多次请求只退一笔。
微信退款单号	refund_id	是	String(32)	1217752501201407033233368018	微信退款单号
申请退款金额	refund_fee	是	int	100	退款总金额,单位为分,可以做部分退款
退款金额	settlement_refund_fee	否	int	100	去掉非充值代金券退款金额后的退款金额，退款金额=申请退款金额-非充值代金券退款金额，退款金额<=申请退款金额
订单金额	total_fee	是	int	100	订单总金额，单位为分，只能为整数，详见支付金额
应结订单金额	settlement_total_fee	否	int	100	应结订单金额=订单金额-免充值代金券金额，应结订单金额<=订单金额。
货币种类	fee_type	否	String(8)	CNY	订单金额货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
现金支付金额	cash_fee	是	int	100	现金支付金额，单位为分，只能为整数，详见支付金额
现金退款金额	cash_refund_fee	否	int	100	现金退款金额，单位为分，只能为整数，详见支付金额
代金券退款总金额	coupon_refund_fee	否	int	100	代金券退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为现金，说明详见代金券或立减优惠

举例：

1<xml>
2    <return_code><![CDATA[SUCCESS]]></return_code>
3    <return_msg><![CDATA[OK]]></return_msg>
4    <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
5    <mch_id><![CDATA[10000100]]></mch_id>
6    <nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
7    <sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign>
8    <result_code><![CDATA[SUCCESS]]></result_code>
9    <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
10    <out_trade_no><![CDATA[1415757673]]></out_trade_no>
11    <><![CDATA[1415701182]]></>
12    <refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
13    <refund_channel><![CDATA[]]></refund_channel>
14    <refund_fee>1</refund_fee>
15    <coupon_refund_fee>0</coupon_refund_fee>
16</xml>

错误码列表

名称	描述	原因	解决方案
PARAM_ERROR	参数错误	请求参数未按指引进行填写	请求参数错误，请重新检查再调用退款申请
SIGNERROR	签名错误	参数签名结果不正确	请检查签名参数和方法是否都符合签名算法要求
SYSTEMERROR	接口返回错误	系统超时	请不要更换商户退款单号，请使用相同参数再次调用API
NOTENOUGH	余额不足	商户可用退款余额不足	此状态代表退款申请失败，商户可根据具体的错误提示做相应的处理
FREQUENCY_LIMITED	频率限制	2个月之前的订单申请退款有频率限制	该笔退款未受理，请降低频率后重试
TRADE_OVERDUE	订单已经超过退款期限	订单已经超过可退款的最大期限(支付后一年内可退款)	请选择其他方式自行退款
USER_ACCOUNT_ABNORMAL	退款请求失败	用户账号注销	此状态代表退款申请失败，商户可自行处理退款。
ERROR	业务错误	申请退款业务错误	改错误会返回具体的错误原因，请依据返回做相应处理
ORDERNOTEXIST	订单不存在	订单不存在	检测退款单号是否正确
REFUND_FEE_MISMATCH	支付金额不匹配	支付金额不匹配	支付金额校验不一致，请核实后再试

文档是否有帮助

更多支持

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