查询单笔退款
更新时间:2025.04.01提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。
1. 接口说明
适用对象: 直连模式机构模式
请求URL: https://apihk.mch.weixin.qq.com/v3/global/refunds/id/{refund_id}
或
https://apihk.mch.weixin.qq.com/v3/global/refunds/out-refund-no/{out_refund_no}
请求方式: GET
频率限制: 150qps
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户号 | mchid | string[1,32] | 是 | Query 微信支付分配的商户号 |
子商户号 | sub_mchid | string[1,32] | 是 | Query 微信支付分配的子商户号 |
机构商户号 | sp_mchid | string[1,32] | 是 | Query 微信支付分配的机构商户号 |
商户退款订单号 | out_refund_no | string[1,64] | 二选一 | Path 返回的商户退款订单号 |
微信支付退款订单号 | refund_id | string[1,32] | Path 微信支付退款订单号 |
请求示例
3. 返回参数
正常返回
参数名 | 变量 | 类型 | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
微信支付退款订单号 | id | string[1,32] | 二选一 | 微信支付退款订单订单号 | |||
商户退款单号 | out_refund_no | string[1,64] | 返回的退款订单号。 | ||||
微信支付交易订单号 | transaction_id | string[1,32] | 是 | 微信支付交易订单号 | |||
商户原交易订单号 | out_trade_no | string[1,64] | 是 | 返回的原交易订单号。 | |||
退款渠道 | channel | string[1,16] | 否 | ORIGINAL:原路退款 | |||
退款入账账户 | recv_account | string[1,64] | 否 | 取当前退款单的退款入账方 | |||
退款资金来源 | fund_source | string[1,30] | 否 | REFUND_SOURCE_UNSETTLED_FUNDS:未结算资金退款(默认使用未结算资金退款) | |||
退款成功时间 | success_time | string[1,64] | 否 | 退款成功时间,当退款状态为退款成功时有返回。 | |||
退款创建时间 | create_time | string[1,64] | 是 | 退款受理时间 | |||
退款状态 | status | string[1,16] | 是 | 退款状态: | |||
退款金额 | amount | object | 是 | 退款金额信息,详细说明见下文 | |||
| |||||||
优惠退款详情 | detail | array | 否 | 优惠退款信息,详细说明见下文 | |||
|
异常返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | code | string[1, 32] | 是 | 错误码,枚举值见错误码列表 |
返回信息 | message | string[1, 256] | 是 | 返回信息,如非空,为错误原因 |
详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 |
返回示例
4. 错误码
错误码 | 描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 接口返回错误 | 请尝试再次掉调用API。 |
REFUND_NOT_EXIST | 退款订单查询失败 | 请检查订单号是否有误以及订单状态是否正确,如:未支付、已支付未退款,如果订单下没有退款单,则会返回此错误码,其他信息是不返回的 |
BIZERR_NEED_RETRY | 无效transaction_id | 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR | 参数错误 | 请求参数错误,请检查参数再调用退款申请 |
APPID_NOT_EXIST | APPID不存在 | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MchID不存在 | 请检查MchID是否正确 |
REQUIRE_POST_METHOD | 请使用post方法 | 请检查请求参数是否通过post方法提交 |
SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |