查询单笔退款API
最新更新时间:2023.10.20 版本说明
提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。
提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。
适用对象:直连模式机构模式
请求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
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户号 | mchid | string[1,32] | 是 | Query 微信支付分配的商户号 注意:仅适用于直连模式 示例值:1900000109 |
子商户号 | sub_mchid | string[1,32] | 是 | Query 微信支付分配的子商户号 注意:仅适用于机构模式 示例值:1900000109 |
机构商户号 | sp_mchid | string[1,32] | 是 | Query 微信支付分配的机构商户号 注意:仅适用于机构模式 示例值:1900000100 |
商户退款订单号 | out_refund_no | string[1,64] | 二选一 | Path返回的商户退款订单号 示例值:1217752501201407033233368018 |
微信支付退款订单号 | refund_id | string[1,32] | Path微信支付退款订单号 示例值:1217752501201407033233368018 |
https://apihk.mch.weixin.qq.com/v3/global/refunds/id/50201308462021060109285031309?sp_mchid=126464383&sub_mchid=426157911
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
微信支付退款订单号 | id | string[1,32] | 二选一 | 微信支付退款订单订单号 示例值:1217752501201407033233368018 |
商户退款单号 | out_refund_no | string[1,64] | 返回的退款订单号。 示例值:1217752501201407033233368018 |
|
微信支付交易订单号 | transaction_id | string[1,32] | 是 | 微信支付交易订单号 示例值:1217752501201407033233368018 |
商户原交易订单号 | out_trade_no | string[1,64] | 是 | 返回的原交易订单号。 示例值:1217752501201407033233368018 |
退款渠道 | channel | string[1,16] | 否 | ORIGINAL:原路退款 BALANCE:退回到余额 OTHER_BALANCE:原账户异常退到其他余额账户 OTHER_BANKCARD:原银行卡异常退到其他银行卡 示例值:ORIGINAL |
退款入账账户 | recv_account | string[1,64] | 否 | 取当前退款单的退款入账方 1)退回银行卡: {银行名称}{卡类型}{卡尾号} 2)退回支付用户零钱: 支付用户零钱 3)退回支付用户零钱通: 支付用户零钱通 示例值:招商银行信用卡0403 |
退款资金来源 | fund_source | string[1,30] | 否 | REFUND_SOURCE_UNSETTLED_FUNDS:未结算资金退款(默认使用未结算资金退款) REFUND_SOURCE_RECHARGE_FUNDS:可用余额退款 示例值:REFUND_SOURCE_UNSETTLED_FUNDS |
退款成功时间 | success_time | string[1,64] | 否 | 退款成功时间,当退款状态为退款成功时有返回。 示例值:2018-06-08T10:34:56+08:00 |
退款创建时间 | create_time | string[1,64] | 是 | 退款受理时间 示例值:2018-06-08T10:34:56+08:00 |
退款状态 | status | string[1,16] | 是 | 退款状态: SUCCESS:退款成功 REFUNDCLOSE:退款关闭 PROCESSING:退款处理中 ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【服务商平台—>交易中心】,手动处理此笔退款 示例值:SUCCESS |
退款金额 | amount | object | 是 | 退款金额信息,详细说明见下文 |
优惠退款详情 | detail | array | 否 | 优惠退款信息,详细说明见下文 |
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | code | string[1, 32] | 是 | 错误码,枚举值见错误码列表 示例值:INVALID_REQUEST |
返回信息 | message | string[1, 256] | 是 | 返回信息,如非空,为错误原因 示例值:参数格式校验错误 |
详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 |
{
"id": "50202002642022072801898085012",
"out_refund_no": "20220724trade003refund001",
"transaction_id": "4200000010202207280683365840",
"out_trade_no": "20220724trade003",
"channel": "ORIGINAL",
"status": "SUCCESS",
"recv_account": "招商银行借记卡0416",
"fund_source": "REFUND_SOURCE_UNSETTLED_FUNDS",
"success_time": "2022-07-28T15:44:24+08:00",
"create_time": "2022-07-28T15:44:07+08:00",
"amount": {
"refund": 500,
"currency": "CNY",
"payer_refund": 250,
"payer_currency": "CNY",
"settlement_refund": 578,
"settlement_currency": "HKD",
"exchange_rate": {
"type": "SETTLEMENT_RATE",
"rate": 86500000
}
},
"detail": [
{
"promotion_id": "11006096615",
"scope": "GLOBAL",
"type": "COUPON",
"amount": 500,
"refund_amount": 250,
"currency": "CNY"
}
]
}
错误码 | 描述 | 解决方案 |
---|---|---|
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 | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证