最新更新时间:2020.5.08 版本说明
提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。
● 如果单个支付订单部分退款次数超过20次请使用退款单号查询
● 当一个订单部分退款超过10笔后,商户用微信订单号或商户订单号调退款查询API查询退款时,默认返回前10笔和total_refund_count(订单总退款次数)。商户需要查询同一订单下超过10笔的退款单时,可传入订单号及offset来查询,微信支付会返回offset及后面的10笔,以此类推。当商户传入的offset超过total_refund_count,则系统会返回报错PARAM_ERROR。
适用对象:直连模式机构模式
请求URL:https://api.mch.weixin.qq.com/pay/refundquery
请求方式: POST
是否需要证书: 不需要
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
公众账号ID | appid | string(32) | 是 | 微信分配的公众账号ID(企业号corpid即为此appId) 示例值:wx8888888888888888 |
商户号 | mch_id | string(32) | 是 | 微信支付分配的商户号 示例值:1900000109 |
子商户公众账号ID | sub_appid | string(32) | 否 | 微信分配的子商户公众账号ID 注意:仅适用于机构模式 示例值:wx8888888888888888 |
子商户号 | sub_mch_id | string(32) | 是 | 微信支付分配的子商户号 注意:仅适用于机构模式 示例值:1900000109 |
随机字符串 | nonce_str | string(32) | 是 | 随机字符串,不长于32位。推荐随机数生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
签名 | sign | string(64) | 是 | 签名,详见签名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
签名类型 | sign_type | string(32) | 否 | 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5 示例值:HMAC-SHA256 |
微信订单号 | transaction_id | string(32) | 四选一 | 微信订单号查询的优先级是: refund_id > out_refund_no > transaction_id > out_trade_no 示例值:1217752501201407033233368018 |
商户订单号 | out_trade_no | string(32) | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:1217752501201407033233368018 |
|
商户退款单号 | out_refund_no | string(64) | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018 |
|
微信退款单号 | refund_id | String(32) | 微信生成的退款单号,在申请退款接口有返回 示例值:1217752501201407033233368018 |
|
偏移量 | offset | int | 否 | 偏移量,当部分退款次数超过10次时可使用,表示返回的查询结果从这个偏移量开始取记录 示例值:15 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<out_refund_no>1415701182</out_refund_no>
<refund_id></refund_id>
<transaction_id>4008450740201411110005820873</transaction_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string(16) | 是 | SUCCESS/FAIL 示例值:SUCCESS |
返回信息 | return_msg | string(128) | 否 | 返回信息,如非空,为错误原因 签名失败 参数格式校验错误 示例值:签名失败 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
业务结果 | result_code | String(16) | 是 | SUCCESS/FAIL SUCCESS退款申请接收成功,退款结果通过退款状态为准 FAIL 示例值:SUCCESS |
错误代码 | err_code | String(32) | 是 | 错误码详见第6节 示例值:SYSTEMERROR |
错误描述 | err_code_des | String(128) | 是 | 结果信息描述 示例值:系统错误 |
公众账号ID | appid | String(32) | 是 | 微信分配的公众账号ID 示例值:wx8888888888888888 |
商户号 | mch_id | String(32) | 是 | 微信支付分配的商户号 示例值:1900000109 |
子商户公众账号ID | sub_appid | String(32) | 否 | 微信分配的子商户公众账号ID 注意:仅适用于机构模式 示例值:wx8888888888888888 |
子商户号 | sub_mch_id | String(32) | 是 | 微信支付分配的子商户号 注意:仅适用于机构模式 示例值:1900000109 |
随机字符串 | nonce_str | String(32) | 是 | 随机字符串,不长于32位。 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
签名 | sign | String(64) | 是 | 签名,详见签名生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
微信订单号 | transaction_id | String(32) | 是 | 微信订单号 示例值:1217752501201407033233368018 |
商户订单号 | out_trade_no | String(32) | 是 | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:1217752501201407033233368018 |
标价金额 | total_fee | int | 是 | 订单总金额,单位为分,只能为整数,详见支付金额 示例值:100 |
标价币种 | fee_type | String(8) | 否 | 订单金额货币类型,符合ISO 4217标准的三位字母代码,列表详见货币类型 示例值:USD |
现金支付金额 | cash_fee | int | 否 | 订单现金支付金额,详见支付金额 示例值:100 |
退款金额 | refund_fee_$n | int | 是 | 退款总金额,单位为分,可以做部分退款 示例值:100 |
订单总退款次数 | total_refund_count | int | 否 | 订单总共已发生的部分退款次数,当请求参数传入offset后有返回 示例值:35 |
退款笔数 | refund_count | int | 是 | 当前返回退款笔数 示例值:1 |
商户退款单号 | out_refund_no_$n | String(64) | 是 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018 |
微信退款单号 | refund_id_$n | String(32) | 是 | 微信退款单号 示例值:1217752501201407033233368018 |
退款渠道 | refund_channel_$n | String(16) | 否 | ORIGINAL:原路退款 BALANCE:退回到余额 OTHER_BALANCE:原账户异常退到其他余额账户 OTHER_BANKCARD:原银行卡异常退到其他银行卡 示例值:ORIGINAL |
退款状态 | refund_status_$n | String(16) | 是 |
退款状态: SUCCESS:退款成功 REFUNDCLOSE:退款关闭。 PROCESSING:退款处理中 CHANGE:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。$n为下标,从0开始编号。 示例值:SUCCESS |
退款资金来源 | refund_account_$n | String(16) | 否 |
REFUND_SOURCE_RECHARGE_FUNDS:可用余额退款/基本账户 REFUND_SOURCE_UNSETTLED_FUNDS:未结算资金退款 $n为下标,从0开始编号。 示例值:REFUND_SOURCE_RECHARGE_FUNDS |
退款入账账户 | refund_recv_accout_$n | String(16) | 是 |
取当前退款单的退款入账方 1)退回银行卡: {银行名称}{卡类型}{卡尾号} 2)退回支付用户零钱: 支付用户零钱 3)退还商户: 商户基本账户 商户结算银行账户 4)退回支付用户零钱通: 支付用户零钱通 示例值:招商银行信用卡0403 |
退款成功时间 | refund_success_time_$n | String(20) | 否 |
退款成功时间,当退款状态为退款成功时有返回。$n为下标,从0开始编号。 示例值:2016-07-25 15:26:26 |
汇率 | rate | String(16) | 否 |
外币兑换RMB的比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 示例值:650000000 |
<xml>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
<out_refund_no_0><![CDATA[1415701182]]></out_refund_no_0>
<out_trade_no><![CDATA[1415757673]]></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>
<sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
</xml>
错误码 | 描述 | 原因 | 解决方案 |
---|---|---|---|
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参数格式是否正确 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证