申请退款
更新时间:2024.11.14当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,微信支付将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家账号上。
|
接口说明
适用对象:直连商户
请求URL: https://api.mch.weixin.qq.com/secapi/pay/refund
请求方式: POST
数据格式: XML
是否需要证书: 需要双向证书。
请求频率限制:150qps,即每秒钟正常的申请退款请求次数不超过150次。
请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1,32] | 是 | 直连商户申请的公众号或移动应用appid。 |
商户号 | mch_id | string[1,32] | 是 | 微信支付分配的商户号 |
随机字符串 | nonce_str | string[1,32] | 是 | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | string[1,32] | 是 | 签名,详见签名生成算法 |
签名类型 | sign_type | string[1,32] | 否 | 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5 |
微信订单号 | transaction_id | string[1,32] | 二选一 | 微信生成的订单号,在支付通知中有返回 |
商户订单号 | out_trade_no | string[1,32] | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 | |
商户退款单号 | out_refund_no | string[1,64] | 是 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 |
订单金额 | total_fee | int | 是 | 订单总金额,单位为分,只能为整数,详见支付金额 |
退款金额 | refund_fee | int | 是 | 退款总金额,订单总金额,单位为分,只能为整数,详见支付金额 |
退款货币种类 | refund_fee_type | string[1,8] | 否 | 退款货币类型,需与支付一致,或者不填。符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
退款原因 | refund_desc | string[1,80] | 否 | 若商户传入,会在下发给用户的退款消息中体现退款原因 |
退款资金来源 | refund_account | string[1,30] | 否 | 仅针对老资金流商户使用 |
退款结果通知url | notify_url | string[1,256] | 否 | 异步接收微信支付退款结果通知的回调地址,通知URL必须为外网可访问的url,不允许带参数 |
请求示例
XML
返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string[1,16] | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
业务结果 | result_code | string[1,16] | 是 | SUCCESS/FAIL |
错误代码 | err_code | string[1,32] | 否 | 列表详见错误码列表 |
错误代码描述 | err_code_des | string[1,128] | 否 | 结果信息描述 |
应用ID | appid | string[1,32] | 是 | 直连商户申请的公众号或移动应用appid。 |
商户号 | mch_id | string[1,32] | 是 | 微信支付分配的商户号 |
随机字符串 | nonce_str | string[1,32] | 是 | 随机字符串,不长于32位 |
签名 | sign | string[1,32] | 是 | 签名,详见签名算法 |
微信订单号 | transaction_id | string[1,32] | 是 | 微信订单号 |
商户订单号 | out_trade_no | string[1,32] | 是 | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 |
商户退款单号 | out_refund_no | string[1,64] | 是 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 |
微信退款单号 | refund_id | string[1,32] | 是 | 微信退款单号 |
退款金额 | refund_fee | int | 是 | 退款总金额,单位为分,可以做部分退款 |
应结退款金额 | settlement_refund_fee | int | 否 | 去掉非充值代金券退款金额后的退款金额,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 |
标价金额 | total_fee | int | 是 | 订单总金额,单位为分,只能为整数,详见支付金额 |
应结订单金额 | settlement_total_fee | int | 否 | 去掉非充值代金券金额后的订单总金额,应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。 |
标价币种 | fee_type | string[1,8] | 否 | 订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金支付金额 | cash_fee | int | 是 | 现金支付金额,单位为分,只能为整数,详见支付金额 |
现金支付币种 | cash_fee_type | string[1,16] | 否 | 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金退款金额 | cash_refund_fee | int | 否 | 现金退款金额,单位为分,只能为整数,详见支付金额 |
代金券类型 | coupon_type_$n | string[1,8] | 否 | CASH:充值代金券 |
代金券退款总金额 | coupon_refund_fee | int | 否 | 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠 |
单个代金券退款金额 | coupon_refund_fee_$n | int | 否 | 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠 |
退款代金券使用数量 | coupon_refund_count | int | 否 | 退款代金券使用数量 |
退款代金券ID | coupon_refund_id_$n | string[1,20] | 否 | 退款代金券ID,$n为下标,从0开始编号 |
返回示例
正常示例
错误码
名称 | 描述 | 解决方案 |
---|---|---|
SYSTEMERROR | 接口返回错误 | 请不要更换商户退款单号,请使用相同参数再次调用API。 |
BIZERR_NEED_RETRY | 退款业务流程错误,需要商户触发重试来解决 | 请不要更换商户退款单号,请使用相同参数再次调用API。 |
TRADE_OVERDUE | 订单已经超过退款期限 | 请选择其他方式自行退款 |
ERROR | 业务错误 | 该错误都会返回具体的错误原因,请根据实际返回做相应处理。 |
USER_ACCOUNT_ABNORMAL | 退款请求失败 | 此状态代表退款申请失败,商户可自行处理退款。 |
INVALID_REQ_TOO_MUCH | 无效请求过多 | 请检查业务是否正常,确认业务正常后请在1分钟后再来重试 |
NOTENOUGH | 余额不足 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 |
INVALID_TRANSACTIONID | 无效transaction_id | 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR | 参数错误 | 请求参数错误,请重新检查再调用退款申请 |
APPID_NOT_EXIST | APPID不存在 | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MCHID不存在 | 请检查MCHID是否正确 |
ORDERNOTEXIST | 订单号不存在 | 请检查你的订单号是否正确且是否已支付,未支付的订单不能发起退款 |
REQUIRE_POST_METHOD | 请使用post方法 | 请检查请求参数是否通过post方法提交 |
SIGNERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |
XML_FORMAT_ERROR | XML格式错误 | 请检查XML参数格式是否正确 |
FREQUENCY_LIMITED | 频率限制 | 该笔退款未受理,请降低频率后重试 |
NOAUTH | 异常IP请求不予受理 | 如果是动态ip,请登录商户平台后台关闭ip安全配置; |
CERT_ERROR | 证书校验错误 | 请检查证书是否正确,证书是否过期或作废。 |
REFUND_FEE_MISMATCH | 订单金额或退款金额与之前请求不一致,请核实后再试 | 订单金额或退款金额与之前请求不一致,请核实后再试 |
INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 |
ORDER_NOT_READY | 订单处理中,暂时无法退款,请稍后再试 | 订单处理中,暂时无法退款,请稍后再试 |