退款申请
更新时间:2025.04.01当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,微信支付将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家账号上。
|
1. 接口说明
适用对象: 直连模式 机构模式
请求URL: https://apihk.mch.weixin.qq.com/v3/global/refunds
请求方式: POST
频率限制: 150qps
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
商户号 | mchid | string[1,32] | 是 | Body 微信支付分配的商户号 | |||
APPID | appid | string[1,32] | 是 | Body 商户在微信开放平台申请移动应用对应的APPID | |||
机构商户号 | sp_mchid | string[1,32] | 是 | Body微信支付分配给机构的商户号 | |||
子商户号 | sub_mchid | string[1,32] | 是 | Body 微信支付分配子商户的商户号 | |||
机构APPID | sp_appid | string[1,32] | 是 | Body 商户在微信公众平台申请服务号对应的APPID | |||
子商户APPID | sub_appid | string[1,32] | 否 | Body 子商户在微信开放平台申请移动应用对应的APPID | |||
微信订单号 | transaction_id | string[1,32] | 二选一 | Body 原支付交易对应的微信订单号 | |||
商户订单号 | out_trade_no | string[1,32] | Body 原支付交易对应的订单号 | ||||
商户退款单号 | out_refund_no | string[1,64] | 是 | Body 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 | |||
退款原因 | reason | string[1,80] | 否 | Body 若商户传入,会在下发给用户的退款消息中体现退款原因 | |||
退款资金来源 | source | string[1,30] | 否 | Body REFUND_SOURCE_UNSETTLED_FUNDS:未结算资金退款(默认使用未结算资金退款) | |||
订单金额 | amount | object | 是 | Body 订单金额信息,详细说明见下文 | |||
| |||||||
退款通知地址 | notify_url | string[1,256] | 否 | Body 异步接收微信退款状态变更的回调地址,通知url必须为外网可访问的url,不能携带参数。请使用https协议链接 |
请求示例
3. 返回参数
正常返回
参数名 | 变量 | 类型 | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
微信支付退款订单号 | id | string[1,32] | 是 | 微信支付退款订单号 | |||
商户退款单号 | out_refund_no | string[1,64] | 是 | 返回的退款订单号。 | |||
退款创建时间 | create_time | string[1,64] | 是 | 退款受理时间, | |||
退款金额 | amount | object | 是 | 退款金额信息,详细说明见下文 | |||
| |||||||
优惠退款详情 | detail | Object | 否 | 优惠退款详情信息,详细说明见下文 | |||
|
注意:goods_remark为备注字段,按照配置原样返回,goods_tag是订单优惠标记,用于区分订单是否可以享受优惠,两个字段内容都在微信后台配置券时进行设置。
异常返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
返回状态码 | code | string[1, 32] | 是 | 错误码,枚举值见错误码列表 | |||
返回信息 | message | string[1, 256] | 是 | 返回信息,如非空,为错误原因 | |||
详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 | |||
|
返回示例
4. 错误码
错误码 | 描述 | 解决方案 |
---|---|---|
RESOURCE_NOT_EXISTS | 查询的资源不存在 | 请检查查询资源的对应id是否填写正确 |
SYSTEM_ERROR | 接口返回错误 | 请不要更换商户退款单号,请使用相同参数再次调用API。否则可能造成资金损失 |
BIZERR_NEED_RETRY | 退款业务流程错误,需要商户触发重试来解决 | 请不要更换商户退款单号,请使用相同参数再次调用API。否则可能造成资金损失 |
TRADE_OVERDUE | 订单已经超过退款期限 | 请选择其他方式自行退款 |
ERROR | 业务错误 | 该错误都会返回具体的错误原因,请根据实际返回做相应处理。 |
USER_ACCOUNT_ABNORMAL | 退款请求失败 | 此状态代表退款申请失败,商户可自行处理退款。 |
INVALID_REQ_TOO_MUCH | 无效请求过多 | 请检查业务是否正常,确认业务正常后请在1分钟后再来重试 |
NOT_ENOUGH | 余额不足 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 |
INVALID_TRANSACTIONID | 无效transaction_id | 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR | 参数错误 | 请求参数错误,请重新检查再调用退款申请 |
APPID_NOT_EXIST | APPID不存在 | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MchID不存在 | 请检查MchID是否正确 |
REQUIRE_POST_METHOD | 请使用post方法 | 请检查请求参数是否通过post方法提交 |
SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |
FREQUENCY_LIMITED | 频率限制 | 该笔退款未受理,请降低频率后重试,该笔退款未受理,请降低频率后原单重试,请勿更换单号 |
ORDER_NOT_EXIST | 订单号不存在 | 请检查你的订单号是否正确且是否已支付,未支付的订单不能发起退款 |
INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 |