查询退款

POST

/pay/refundquery

应用场景

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

退款状态机

退款状态变化如下：

错误码

名称	描述	原因	解决方案
SYSTEMERROR	接口返回错误	系统超时	请尝试再次调用API。
REFUNDNOTEXIST	退款订单查询失败	订单号错误或订单状态不正确	请检查订单号是否有误以及订单状态是否正确，如：未支付、已支付未退款
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	请求参数符合参数格式，但不符合业务规则	此状态代表退款申请失败，商户可根据具体的错误提示做相应的处理。	此状态代表退款申请失败，商户可根据具体的错误提示做相应的处理。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/pay/refundquery' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <mch_id>10000100</mch_id>
   <nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
   <out_refund_no></out_refund_no>
   <out_trade_no>1415757673</out_trade_no>
   <refund_id></refund_id>
   <transaction_id></transaction_id>
   <sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>'

响应示例

<xml>
   <appid><![CDATA[wx8888888888888888]]></appid>
   <mch_id><![CDATA[1900000109]]></mch_id>
   <nonce_str><![CDATA[5K8264ILTKCH16CQ2502SI8ZNMTM67VS]]></nonce_str>
   <out_trade_no><![CDATA[1217752501201407033233368018]]></out_trade_no>
   <refund_count>1</refund_count>
   <refund_fee_0>1</refund_fee_0>
   <refund_id_0><![CDATA[2008450740201411110000174436]]></refund_id_0>
   <refund_status_0><![CDATA[PROCESSING]]></refund_status_0>
   <result_code><![CDATA[SUCCESS]]></result_code>
   <return_code><![CDATA[SUCCESS]]></return_code>
   <return_msg><![CDATA[OK]]></return_msg>
   <cash_refund_fee><![CDATA[90]]></cash_refund_fee>
   <sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
   <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
</xml>

请求参数

Body 参数application/xml

appid

string

公众账号ID

必需

微信支付分配的公众账号ID（企业号corpid即为此appid）

mch_id

string

商户号

必需

微信支付分配的商户号

nonce_str

string

随机字符串

必需

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

out_refund_no

string

商户退款单号

必需

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

out_trade_no

string

商户订单号

必需

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

refund_id

string

微信退款单号

必需

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

transaction_id

string

微信订单号

必需

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

sign

string

签名

必需

签名，详见签名生成算法

sign_type

string

签名类型

可选

签名类型，目前支持HMAC-SHA256和MD5，默认为MD5

offset

string

偏移量

可选

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

示例

返回响应

🟢200成功

application/json

Body

appid

string

公众账号ID

必需

微信分配的公众账号ID（企业号corpid即为此appid）

mch_id

string

商户号

必需

微信支付分配的商户号

nonce_str

string

随机字符串

必需

随机字符串，不长于32位

out_trade_no

string

商户订单号

必需

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

refund_count

string

退款笔数

必需

当前返回退款笔数

refund_fee_0

string

必需

refund_id_0

string

必需

refund_status_0

string

必需

result_code

string

业务结果

必需

SUCCESS/FAIL SUCCESS退款申请接收成功，退款结果以退款状态为准 FAIL

return_code

string

返回状态码

必需

SUCCESS/FAIL 此字段是通信标识，表示接口层的请求结果，并非退款状态。

return_msg

string

返回信息

必需

当return_code为FAIL时返回信息为错误原因，例如签名失败参数格式校验错误

cash_refund_fee

string

必需

sign

string

签名

必需

签名，详见签名算法

transaction_id

string

微信订单号

必需

微信订单号

err_code

string

错误码

必需

错误码详见第6节

err_code_des

string

错误描述

必需

结果信息描述

total_refund_count

string

订单总退款次数

可选

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

total_fee

string

订单金额

必需

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

settlement_total_fee

string

应结订单金额

可选

当订单使用了免充值型优惠券后返回该参数，应结订单金额=订单金额-免充值优惠券金额。

fee_type

string

货币种类

可选

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

cash_fee

string

现金支付金额

必需

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

out_refund_no_$n

string

商户退款单号

必需

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

refund_id_$n

string

微信退款单号

必需

微信退款单号

refund_channel_$n

string

退款渠道

可选

ORIGINAL—原路退款 BALANCE—退回到余额 OTHER_BALANCE—原账户异常退到其他余额账户 OTHER_BANKCARD—原银行卡异常退到其他银行卡

refund_fee_$n

string

申请退款金额

必需

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

refund_fee

string

退款总金额

必需

各退款单的退款金额累加

coupon_refund_fee

string

代金券退款总金额

必需

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

settlement_refund_fee_$n

string

退款金额

可选

退款金额=申请退款金额-非充值代金券退款金额，退款金额<=申请退款金额

coupon_type_$n_$m

string

代金券类型

可选

CASH--充值代金券 NO_CASH---非充值优惠券开通免充值券功能，并且订单使用了优惠券后有返回（取值：CASH、NO_CASH）。

n 为下标,

m为下标,从0开始编号，举例：coupon_type_1

coupon_refund_fee_$n

string

总代金券退款金额

可选

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

coupon_refund_count_$n

string

退款代金券使用数量

可选

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

coupon_refund_id_$n_$m

string

退款代金券ID

可选

退款代金券ID,

n 为下标，

m为下标，从0开始编号

coupon_refund_fee_$n_$m

string

单个代金券退款金额

可选

单个退款代金券支付金额,

n 为下标，

m为下标，从0开始编号

refund_status_$n

string

退款状态

必需

退款状态： SUCCESS—退款成功 REFUNDCLOSE—退款关闭，指商户发起退款失败的情况。 PROCESSING—退款处理中 CHANGE—退款异常，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，可前往商户平台（pay.weixin.qq.com）-交易中心，手动处理此笔退款。$n为下标，从0开始编号。

refund_account_$n

string

退款资金来源

可选

REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款 $n为下标，从0开始编号。

refund_recv_accout_$n

string

退款入账账户

必需

取当前退款单的退款入账方 1）退回银行卡： {银行名称}{卡类型}{卡尾号} 2）退回支付用户零钱: 支付用户零钱 3）退还商户: 商户基本账户商户结算银行账户 4）退回支付用户零钱通: 支付用户零钱通

refund_success_time_$n

string

退款成功时间

可选

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

cash_refund_fee

string

用户退款金额

必需

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

申请退款

下载交易账单

查询退款

应用场景#

分页查询#

退款状态机#

错误码#

请求参数

返回响应

应用场景

分页查询

退款状态机

错误码