查询退款

更新时间：2024.11.14

提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，银行卡支付的退款3个工作日后重新查询退款状态。

注意：

如果单个支付订单部分退款次数超过20次请使用退款单号查询。

分页查询

当一个订单部分退款超过10笔后，商户用微信订单号或商户订单号调退款查询API查询退款时，默认返回前10笔和total_refund_count（订单总退款次数）。商户需要查询同一订单下超过10笔的退款单时，可传入订单号及offset来查询，微信支付会返回offset及后面的10笔，以此类推。当商户传入的offset超过total_refund_count，则系统会返回报错PARAM_ERROR。

举例：

一笔订单下的退款单有36笔，当商户想查询第25笔时，可传入订单号及offset=24，微信支付平台会返回第25笔到第35笔的退款单信息，或商户可直接传入退款单号查询退款

接口说明

适用对象：直连商户

请求URL： https://api.mch.weixin.qq.com/pay/refundquery

请求方式： POST

数据格式： XML

是否需要证书：否

请求参数

参数名	变量	类型[长度限制]	必填	描述
应用ID	appid	string[1,32]	是	直连商户申请的公众号或移动应用appid。示例值：wxcbda96de0b165486
商户号	mch_id	string[1,32]	是	微信支付分配的商户号示例值：1900000109
随机字符串	nonce_str	string[1,32]	是	随机字符串，不长于32位。推荐随机数生成算法示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
签名	sign	string[1,32]	是	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6
签名类型	sign_type	string[1,32]	否	签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 示例值：HMAC-SHA256
微信订单号	transaction_id	string[1,32]	四选一	微信生成的订单号，在支付通知中有返回示例值：1217752501201407033233368018
商户订单号	out_trade_no	string[1,32]		商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-\|*@ ，且在同一个商户号下唯一。 transaction_id、out_trade_no二选一，如果同时存在优先级：transaction_id> out_trade_no 示例值：1217752501201407033233368018
商户退款单号	out_refund_no	string[1,64]		商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-\|*@ ，同一退款单号多次请求只退一笔。示例值：1217752501201407033233368018
微信退款单号	refund_id	string[1,32]		微信生成的退款单号，在申请退款接口有返回示例值：1217752501201407033233368018
偏移量	offset	int	否	偏移量，当部分退款次数超过10次时可使用，表示返回的查询结果从这个偏移量开始取记录示例值：15

请求示例

XML

1<xml>
2  <appid>wx2421b1c4370ec43b</appid>
3  <mch_id>10000100</mch_id>
4  <nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
5  <out_refund_no></out_refund_no>
6  <out_trade_no>1415757673</out_trade_no>
7  <refund_id></refund_id>
8  <transaction_id></transaction_id>
9  <sign>66FFB727015F450D167EF38CCC549521</sign>
10</xml>

返回参数

参数名	变量	类型[长度限制]	必填	描述
返回状态码	return_code	string[1,16]	是	SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断示例值：SUCCESS
返回信息	return_msg	string[1,128]	否	返回信息，如非空，为错误原因如：签名失败等。示例值：签名失败

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

参数名	变量	类型[长度限制]	必填	描述
业务结果	result_code	string[1,16]	是	SUCCESS/FAIL 示例值：SUCCESS
错误代码	err_code	string[1,32]	否	列表详见错误码列表示例值：SYSTEMERROR
错误代码描述	err_code_des	string[1,128]	否	结果信息描述示例值：系统超时
应用ID	appid	string[1,32]	是	直连商户申请的公众号或移动应用appid。示例值：wxcbda96de0b165486
商户号	mch_id	string[1,32]	是	微信支付分配的商户号示例值：1900000109
随机字符串	nonce_str	string[1,32]	是	随机字符串，不长于32位示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
签名	sign	string[1,32]	是	签名，详见签名算法示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
订单总退款次数	total_refund_count	int	否	订单总共已发生的部分退款次数，当请求参数传入offset后有返回示例值：35
微信订单号	transaction_id	string[1,32]	是	微信订单号示例值：4007752501201407033233368018
商户订单号	out_trade_no	string[1,32]	是	商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-\|*@ ，且在同一个商户号下唯一。示例值：33368018
订单金额	total_fee	int	是	订单总金额，单位为分，只能为整数，详见支付金额示例值：100
应结订单金额	settlement_total_fee	int	否	当订单使用了免充值型优惠券后返回该参数，应结订单金额=订单金额-免充值优惠券金额。示例值：100
货币种类	fee_type	string[1,8]	否	订单金额货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型示例值：CNY
现金支付金额	cash_fee	int	是	现金支付金额，单位为分，只能为整数，详见支付金额示例值：100
退款笔数	refund_count	int	是	当前返回退款笔数示例值：1
商户退款单号	out_refund_no_$n	string[1,64]	是	商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-\|*@ ，同一退款单号多次请求只退一笔。 $n为下标，从0开始编号。示例值：121775250
微信退款单号	refund_id_$n	string[1,32]	是	微信退款单号，$n为下标，从0开始编号。示例值：2007752501201407033233368018
退款渠道	refund_channel_$n	string[1,16]	否	ORIGINAL：原路退款 BALANCE：退回到余额 OTHER_BALANCE：原账户异常退到其他余额账户 OTHER_BANKCARD：原银行卡异常退到其他银行卡示例值：ORIGINAL
申请退款金额	refund_fee_$n	int	是	退款总金额,单位为分,可以做部分退款示例值：100
退款金额	refund_fee	int	是	退款总金额,单位为分,可以做部分退款示例值：100
代金券类型	coupon_type_$n_$m	string[1,8]	否	CASH：充值代金券 NO_CASH：非充值优惠券开通免充值券功能，并且订单使用了优惠券后有返回（取值：CASH、NO_CASH）。$n为下标,$m为下标,从0开始编号，举例：coupon_type_$0_$1 示例值：CASH
总代金券退款金额	coupon_refund_fee_$n	int	否	代金券退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为现金，说明详见代金券或立减优惠示例值：100
退款代金券使用数量	coupon_refund_count_$n	int	否	退款代金券使用数量 ,$n为下标,从0开始编号示例值：1
退款代金券ID	coupon_refund_id_$n_$m	string[1,20]	否	退款代金券ID, $n为下标，$m为下标，从0开始编号示例值：10000
单个代金券退款金额	coupon_refund_fee_$n_$m	int	否	单个退款代金券支付金额, $n为下标，$m为下标，从0开始编号示例值：100
退款状态	refund_status_$n	string[1,16]	是	退款状态： SUCCESS：退款成功 REFUNDCLOSE：退款关闭。 PROCESSING：退款处理中 CHANGE：退款异常，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，可前往商户平台（pay.weixin.qq.com）-交易中心，手动处理此笔退款。$n为下标，从0开始编号。示例值：SUCCESS
退款资金来源	refund_account_$n	string[1,30]	否	REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款 $n为下标，从0开始编号。示例值：REFUND_SOURCE_RECHARGE_FUNDS
退款入账账户	refund_recv_accout_$n	string[1,64]	是	取当前退款单的退款入账方 1、退回银行卡：{银行名称}{卡类型}{卡尾号} 2、退回支付用户零钱:支付用户零钱 3、退还商户:商户基本账户、商户结算银行账户 4、退回支付用户零钱通:支付用户零钱通 5、退回用户经营账户：用户经营账户 6、退回支付用户银行电子账户：支付用户银行电子账户 7、退回支付用户零花钱：支付用户零花钱 8、退回支付用户来华零钱包：支付用户来华零钱包 9、退回企业支付商户：企业支付商户示例值：招商银行信用卡0403
退款成功时间	refund_success_time_$n	string[1,20]	否	退款成功时间，当退款状态为退款成功时有返回。$n为下标，从0开始编号。示例值：2016-07-25 15:26:26

返回示例

正常示例

1<xml>
2   <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
3   <mch_id><![CDATA[10000100]]></mch_id>
4   <nonce_str><![CDATA[TeqClE3i0mvn3DrK]]></nonce_str>
5   <out_refund_no_0><![CDATA[1415701182]]></out_refund_no_0>
6   <out_trade_no><![CDATA[1415757673]]></out_trade_no>
7   <refund_count>1</refund_count>
8   <refund_fee_0>1</refund_fee_0>
9   <refund_id_0><![CDATA[2008450740201411110000174436]]></refund_id_0>
10   <refund_status_0><![CDATA[PROCESSING]]></refund_status_0>
11   <result_code><![CDATA[SUCCESS]]></result_code>
12   <return_code><![CDATA[SUCCESS]]></return_code>
13   <return_msg><![CDATA[OK]]></return_msg>
14   <sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
15   <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
16</xml>

错误码

名称	描述	解决方案
SYSTEMERROR	接口返回错误	请尝试再次掉调用API。
REFUNDNOTEXIST	退款订单查询失败	请检查订单号是否有误以及订单状态是否正确，如：未支付、已支付未退款
INVALID_TRANSACTIONID	无效transaction_id	请求参数错误，检查原交易号是否存在或发起支付交易接口返回失败
PARAM_ERROR	参数错误	请求参数错误，请检查参数再调用退款申请
APPID_NOT_EXIST	APPID不存在	请检查APPID是否正确
MCHID_NOT_EXIST	MCHID不存在	请检查MCHID是否正确
REQUIRE_POST_METHOD	请使用post方法	请检查请求参数是否通过post方法提交
SIGNERROR	签名错误	请检查签名参数和方法是否都符合签名算法要求
XML_FORMAT_ERROR	XML格式错误	请检查XML参数格式是否正确

文档是否有帮助

更多支持

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