查询退款

更新时间:2024.11.13

应用场景

提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款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笔的退款单信息,或商户可直接传入退款单号查询退款

接口地址

接口链接:https://api.mch.weixin.qq.com/pay/refundquery

是否需要证书

不需要。

请求参数

字段名

变量名

必填

类型

示例值

描述

服务商的APPID

appid

String(32)

wxd678efh567hg6787

服务商商户的APPID

商户号

mch_id

String(32)

1230000109

受理商户的商户号

子商户应用ID

sub_appid

String(32)

wx8888888888888888

子商户在微信开放平台上申请的APPID

子商户号

sub_mch_id

String(32)

1900000109

子商户的商户号

随机字符串

nonce_str

String(32)

5K8264ILTKCH16CQ2502SI8ZNMTM67VS

随机字符串,不长于32位。推荐随机数生成算法

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名,详见签名生成算法

微信订单号

transaction_id

四选一

String(32)

1217752501201407033233368018

微信订单号查询的优先级是: refund_id > out_refund_no > transaction_id > out_trade_no

商户订单号

out_trade_no

String(32)

1217752501201407033233368018

商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号

商户退款单号

out_refund_no

String(64)

1217752501201407033233368018

商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。

微信退款单号

refund_id

String(32)

1217752501201407033233368018

微信生成的退款单号,在申请退款接口有返回

偏移量

offset

int

15

偏移量,当部分退款次数超过10次时可使用,表示返回的查询结果从这个偏移量开始取记录

举例如下:

1<xml>
2   <appid>wx2421b1c4370ec43b</appid>
3   <mch_id>10000100</mch_id>
4   <sub_appid>wx8888888888888888</sub_appid>
5   <sub_mch_id>10000101</sub_mch_id>
6   <nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
7   <out_refund_no></out_refund_no>
8   <out_trade_no>1415757673</out_trade_no>
9   <refund_id></refund_id>
10   <transaction_id></transaction_id>
11   <sign>66FFB727015F450D167EF38CCC549521</sign>
12</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)

wxd678efh567hg6787

受理商户的APPID

商户号

mch_id

String(32)

1230000109

受理商户的商户号

子商户应用ID

sub_appid

String(32)

wx8888888888888888

子商户在微信开放平台上申请的APPID

子商户号

sub_mch_id

String(32)

1900000109

子商户的商户号

随机字符串

nonce_str

String(32)

5K8264ILTKCH16CQ2502SI8ZNMTM67VS

随机字符串,不长于32位

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名,详见签名算法

微信订单号

transaction_id

String(32)

1217752501201407033233368018

微信订单号

商户订单号

out_trade_no

String(32)

1217752501201407033233368018

商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号

订单总金额

total_fee

int

100

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

订单金额货币种类

fee_type

String(8)

CNY

订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型

现金支付金额

cash_fee

int

100

现金支付金额,单位为分,只能为整数,详见支付金额

订单总退款次数

total_refund_count

int

35

订单总共已发生的部分退款次数,当请求参数传入offset后有返回

退款笔数

refund_count

int

1

当前返回退款笔数

商户退款单号

out_refund_no_$n

String(64)

1217752501201407033233368018

商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。

微信退款单号

refund_id_$n

String(32)

1217752501201407033233368018

微信退款单号

退款渠道

refund_channel_$n

String(16)

ORIGINAL

ORIGINAL—原路退款

BALANCE—退回到余额

OTHER_BALANCE—原账户异常退到其他余额账户

OTHER_BANKCARD—原银行卡异常退到其他银行卡

退款总金额

refund_fee

int

100

各退款单的退款金额累加

代金券退款总金额

coupon_refund_fee

int

100

各退款单的代金券退款金额累加

退款金额

refund_fee_$n

int

100

退款总金额,单位为分,可以做部分退款

代金券退款金额

coupon_refund_fee_$n

int

100

代金券或立减优惠退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠

代金券使用数量

coupon_refund_count_$n

int

1

代金券使用数量 ,$n为下标,从0开始编号

代金券类型

coupon_type_$n_$m

String(8)

CASH

CASH--充值代金券

NO_CASH---非充值优惠券

开通免充值券功能,并且订单使用了优惠券后有返回(取值:CASH、NO_CASH)。$n为下标,$m为下标,从0开始编号,举例:coupon_type_$0_$1

代金券ID

coupon_refund_id_$n_$m

String(20)

10000 

代金券或立减优惠ID, $n为下标,$m为下标,从0开始编号

单个代金券支付金额

coupon_refund_fee_$n_$m

int

100

单个代金券或立减优惠支付金额, $n为下标,$m为下标,从0开始编号

退款状态

refund_status_$n

String(16)

SUCCESS

退款状态:

SUCCESS—退款成功

REFUNDCLOSE—退款关闭,指商户发起退款失败的情况。

PROCESSING—退款处理中

CHANGE—退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。$n为下标,从0开始编号。

退款入账账户

refund_recv_accout_$n

String(64)

招商银行信用卡0403

取当前退款单的退款入账方

1)退回银行卡:{银行名称}{卡类型}{卡尾号}

2)退回支付用户零钱:支付用户零钱

3)退还商户:商户基本账户、商户结算银行账户

4)退回支付用户零钱通:支付用户零钱通

5)退回用户经营账户:用户经营账户

6)退回支付用户银行电子账户:支付用户银行电子账户

7)退回支付用户零花钱:支付用户零花钱

8)退回支付用户来华零钱包:支付用户来华零钱包

9)退回企业支付商户:企业支付商户

退款成功时间

refund_success_time_$n

String(20)

2016-07-25 15:26:26

退款成功时间,当退款状态为退款成功时有返回。$n为下标,从0开始编号。

用户退款金额

cash_refund_fee

int

90

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

举例如下:

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

错误码

名称

描述

原因

解决方案

SYSTEMERROR

接口返回错误

系统超时

请尝试再次掉调用API。

INVALID_TRANSACTIONID

无效transaction_id

请求参数未按指引进行填写

请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败

PARAM_ERROR

参数错误

请求参数未按指引进行填写

请求参数错误,请检查参数再调用退款申请

APPID_NOT_EXIST

APPID不存在

参数中缺少APPID

请检查APPID是否正确

MCHID_NOT_EXIST

MCHID不存在

参数中缺少MCHID

请检查MCHID是否正确

REQUIRE_POST_METHOD

请使用post方法

未使用post传递参数 

请检查请求参数是否通过post方法提交

SIGNERROR

签名错误

参数签名结果不正确

请检查签名参数和方法是否都符合签名算法要求

XML_FORMAT_ERROR

XML格式错误

XML格式错误

请检查XML参数格式是否正确

INVALID_REQUEST

请求参数符合参数格式,但不符合业务规则

此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。

此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。

 

反馈
咨询
目录
置顶