查询退款
更新时间:2025.02.19提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。
|
接口说明
适用对象: 直连模式 机构模式
请求URL: https://apihk.mch.weixin.qq.com/pay/refundquery
请求方式: POST
是否需要证书: 不需要
请求参数
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
公众账号ID | appid | string(32) | 是 | 微信分配的公众账号ID(企业号corpid即为此appId) |
商户号 | mch_id | string(32) | 是 | 微信支付分配的商户号 |
子商户公众账号ID | sub_appid | string(32) | 否 | 微信分配的子商户公众账号ID |
子商户号 | sub_mch_id | string(32) | 是 | 微信支付分配的子商户号 |
随机字符串 | nonce_str | string(32) | 是 | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | string(64) | 是 | 签名,详见签名生成算法 |
签名类型 | sign_type | string(32) | 否 | 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5 |
微信订单号 | transaction_id | string(32) | 四选一 | 微信订单号查询的优先级是: refund_id > out_refund_no > transaction_id > out_trade_no |
商户订单号 | out_trade_no | string(32) | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 | |
商户退款单号 | out_refund_no | string(64) | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 | |
微信退款单号 | refund_id | String(32) | 微信生成的退款单号,在申请退款接口有返回 | |
偏移量 | offset | int | 否 | 偏移量,当部分退款次数超过10次时可使用,表示返回的查询结果从这个偏移量开始取记录 |
请求示例:
返回参数
正常返回
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string(16) | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string(128) | 否 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
业务结果 | result_code | String(16) | 是 | SUCCESS/FAIL |
错误代码 | err_code | String(32) | 是 | 错误码详见第6节 |
错误描述 | err_code_des | String(128) | 是 | 结果信息描述 |
公众账号ID | appid | String(32) | 是 | 微信分配的公众账号ID |
商户号 | mch_id | String(32) | 是 | 微信支付分配的商户号 |
子商户公众账号ID | sub_appid | String(32) | 否 | 微信分配的子商户公众账号ID |
子商户号 | sub_mch_id | String(32) | 是 | 微信支付分配的子商户号 |
随机字符串 | nonce_str | String(32) | 是 | 随机字符串,不长于32位。 |
签名 | sign | String(64) | 是 | 签名,详见签名生成算法 |
微信订单号 | transaction_id | String(32) | 是 | 微信订单号 |
商户订单号 | out_trade_no | String(32) | 是 | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 |
标价金额 | total_fee | int | 是 | 订单总金额,单位为分,只能为整数,详见支付金额 |
标价币种 | fee_type | String(8) | 否 | 订单金额货币类型,符合ISO 4217标准的三位字母代码,列表详见货币类型 |
现金支付金额 | cash_fee | int | 否 | 订单现金支付金额,详见支付金额 |
退款金额 | refund_fee_$n | int | 是 | 退款总金额,单位为分,可以做部分退款 |
订单总退款次数 | total_refund_count | int | 否 | 订单总共已发生的部分退款次数,当请求参数传入offset后有返回 |
退款笔数 | refund_count | int | 是 | 当前返回退款笔数 |
商户退款单号 | out_refund_no_$n | String(64) | 是 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 |
微信退款单号 | refund_id_$n | String(32) | 是 | 微信退款单号 |
退款渠道 | refund_channel_$n | String(16) | 否 | ORIGINAL:原路退款 |
退款状态 | refund_status_$n | String(16) | 是 | 退款状态: |
退款资金来源 | refund_account_$n | String(16) | 否 | REFUND_SOURCE_RECHARGE_FUNDS:可用余额退款/基本账户 |
退款入账账户 | refund_recv_accout_$n | String(16) | 是 | 取当前退款单的退款入账方 |
退款成功时间 | refund_success_time_$n | String(20) | 否 | 退款成功时间,当退款状态为退款成功时有返回。$n为下标,从0开始编号。 |
汇率 | rate | String(16) | 否 | 外币兑换RMB的比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 |
举例如下:
错误码
错误码 | 描述 | 原因 | 解决方案 |
---|---|---|---|
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参数格式是否正确 |