最新更新时间:2022.08.29 版本说明
提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,建议在提交退款申请后1分钟发起查询退款状态,一般来说零钱支付的退款5分钟内到账,银行卡支付的退款1-3个工作日到账。
适用对象:服务商
请求URL:https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/{out_refund_no}
请求方式:GET
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户退款单号 | out_refund_no | string[1, 64] | 是 | path商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018 |
子商户号 | sub_mchid | string[1, 32] | 是 | query子商户的商户号,由微信支付生成并下发。 示例值:1900000109 |
https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/1217752501201407033233368018?sub_mchid=1900000109
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
微信支付退款单号 | refund_id | string[1, 32] | 是 | 微信支付退款单号 示例值:50000000382019052709732678859 |
商户退款单号 | out_refund_no | string[1, 64] | 是 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018 |
微信支付订单号 | transaction_id | string[1, 32] | 是 | 微信支付交易订单号 示例值:1217752501201407033233368018 |
商户订单号 | out_trade_no | string[1, 32] | 是 | 原支付交易对应的商户订单号 示例值:1217752501201407033233368018 |
退款渠道 | channel | string[1, 16] | 是 | 枚举值: ORIGINAL:原路退款 BALANCE:退回到余额 OTHER_BALANCE:原账户异常退到其他余额账户 OTHER_BANKCARD:原银行卡异常退到其他银行卡 示例值:ORIGINAL |
退款入账账户 | user_received_account | string[1, 64] | 是 | 取当前退款单的退款入账方,有以下几种情况: 1)退回银行卡:{银行名称}{卡类型}{卡尾号} 2)退回支付用户零钱:支付用户零钱 3)退还商户:商户基本账户商户结算银行账户 4)退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403 |
退款成功时间 | success_time | string[1, 64] | 否 | 退款成功时间,当退款状态为退款成功时有返回。 示例值:2020-12-01T16:18:12+08:00 |
退款创建时间 | create_time | string[1, 64] | 是 | 退款受理时间 示例值:2020-12-01T16:18:12+08:00 |
退款状态 | status | string[1, 32] | 是 | 退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往服务商平台-交易中心,手动处理此笔退款。 枚举值: SUCCESS:退款成功 CLOSED:退款关闭 PROCESSING:退款处理中 ABNORMAL:退款异常 示例值:SUCCESS |
资金账户 | funds_account | string[1, 32] | 否 | 退款所使用资金对应的资金账户类型 枚举值: UNSETTLED : 未结算资金 AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 OPERATION : 运营户 BASIC : 基本账户(含可用余额和不可用余额) 示例值:UNSETTLED |
+金额信息 | amount | object | 是 | 金额详细信息 |
+优惠退款信息 | promotion_detail | array | 否 | 优惠退款信息 |
{
"refund_id": "50000000382019052709732678859",
"out_refund_no": "1217752501201407033233368018",
"transaction_id": "1217752501201407033233368018",
"out_trade_no": "1217752501201407033233368018",
"channel": "ORIGINAL",
"user_received_account": "招商银行信用卡0403",
"success_time": "2020-12-01T16:18:12+08:00",
"create_time": "2020-12-01T16:18:12+08:00",
"status": "SUCCESS",
"funds_account": "UNSETTLED",
"amount": {
"total": 100,
"refund": 100,
"from": [
{
"account": "AVAILABLE",
"amount": 444
}
],
"payer_total": 90,
"payer_refund": 90,
"settlement_refund": 100,
"settlement_total": 100,
"discount_refund": 10,
"currency": "CNY"
},
"promotion_detail": [
{
"promotion_id": "109519",
"scope": "SINGLE",
"type": "DISCOUNT",
"amount": 5,
"refund_amount": 100,
"goods_detail":[
{
"merchant_goods_id": "1217752501201407033233368018",
"wechatpay_goods_id": "1001",
"goods_name": "iPhone6s 16G",
"unit_price": 528800,
"refund_amount": 528800,
"refund_quantity": 1
}
]
}
]
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统超时 | 请不要更换商户退款单号,请使用相同参数再次调用API。 |
400 | PARAM_ERROR | 参数错误 | 请求参数错误,请检查参数再调用退款查询 |
404 | MCH_NOT_EXISTS | MCHID不存在 | 请检查MCHID是否正确 |
404 | RESOURCE_NOT_EXISTS | 退款单查询失败 | 请检查退款单号是否有误以及订单状态是否正确,如:未支付、已支付未退款 |
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |