当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,微信支付将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家账号上。
注意:
1、交易时间超过一年的订单无法提交退款
2、微信支付退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交,请不要更换退款单号,请使用原商户退款单号
3、请求频率限制:150qps,即每秒钟正常的申请退款请求次数不超过150次
4、每个支付订单的部分退款次数不能超过50次
5、如果同一个用户有多笔退款,建议分不同批次进行退款,避免并发退款导致退款失败
6、申请退款接口的返回仅代表业务的受理情况,具体退款是否成功,需要通过退款查询接口获取结果。
7、一个月之前的订单申请退款频率限制为:5000/min
8、同一笔订单多次退款的请求需相隔1分钟
接口链接:https://api.mch.weixin.qq.com/secapi/pay/refund
请求需要双向证书。 详见证书使用
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID(企业号corpid即为此appid) |
商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5 |
微信支付订单号 | transaction_id | 二选一 | String(32) | 1217752501201407033233368018 | 微信生成的订单号,在支付通知中有返回 |
商户订单号 | out_trade_no | String(32) | 1217752501201407033233368018 | 商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号 transaction_id、out_trade_no二选一,如果同时存在优先级:transaction_id> out_trade_no |
|
商户退款单号 | out_refund_no | 是 | String(64) | 1217752501201407033233368018 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 |
订单金额 | total_fee | 是 | int | 100 | 订单总金额,单位为分,只能为整数,详见支付金额 |
退款金额 | refund_fee | 是 | int | 100 | 退款总金额,订单总金额,单位为分,只能为整数,详见支付金额 |
退款货币种类 | refund_fee_type | 否 | String(8) | CNY | 退款货币类型,需与支付一致,或者不填。符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
退款原因 | refund_desc | 否 | String(80) | 商品已售完 |
若商户传入,会在下发给用户的退款消息中体现退款原因 注意:若订单退款金额≤1元,且属于部分退款,则不会在退款消息中体现退款原因 |
退款资金来源 | refund_account | 否 | String(30) | REFUND_SOURCE_RECHARGE_FUNDS |
仅针对老资金流商户使用 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款(默认使用未结算资金退款) REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款 |
退款结果通知url | notify_url | 否 | String(256) | https://weixin.qq.com/notify/ |
异步接收微信支付退款结果通知的回调地址,通知URL必须为外网可访问的url,不允许带参数 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效。 |
举例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<out_refund_no>1415701182</out_refund_no>
<out_trade_no>1415757673</out_trade_no>
<refund_fee>1</refund_fee>
<total_fee>1</total_fee>
<transaction_id>4006252001201705123297353072</transaction_id>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信标识,表示接口层的请求结果,并非退款状态。 |
返回信息 | return_msg | 是 | String(128) | OK |
当return_code为FAIL时返回信息为错误原因 ,例如 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
业务结果 | result_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL SUCCESS退款申请接收成功,结果通过退款查询接口查询 FAIL 提交业务失败 |
错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 列表详见错误码列表 |
错误代码描述 | err_code_des | 否 | String(128) | 系统超时 | 结果信息描述 |
公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID |
商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位 |
签名 | sign | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 签名,详见签名算法 |
微信支付订单号 | transaction_id | 是 | String(32) | 4007752501201407033233368018 | 微信订单号 |
商户订单号 | out_trade_no | 是 | String(32) | 33368018 | 商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号 |
商户退款单号 | out_refund_no | 是 | String(64) | 121775250 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 |
微信退款单号 | refund_id | 是 | String(32) | 2007752501201407033233368018 | 微信退款单号 |
退款金额 | refund_fee | 是 | int | 100 | 退款总金额,单位为分,可以做部分退款 |
应结退款金额 | settlement_refund_fee | 否 | int | 100 | 去掉非充值代金券退款金额后的退款金额,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 |
标价金额 | total_fee | 是 | int | 100 | 订单总金额,单位为分,只能为整数,详见支付金额 |
应结订单金额 | settlement_total_fee | 否 | int | 100 | 去掉非充值代金券金额后的订单总金额,应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。 |
标价币种 | fee_type | 否 | String(8) | CNY | 订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金支付金额 | cash_fee | 是 | int | 100 | 现金支付金额,单位为分,只能为整数,详见支付金额 |
现金支付币种 | cash_fee_type | 否 | String(16) | CNY | 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金退款金额 | cash_refund_fee | 否 | int | 100 | 现金退款金额,单位为分,只能为整数,详见支付金额 |
代金券类型 | coupon_type_$n | 否 | String(8) | CASH |
CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回(取值:CASH、NO_CASH)。$n为下标,从0开始编号,举例:coupon_type_0 |
代金券退款总金额 | coupon_refund_fee | 否 | int | 100 | 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠 |
单个代金券退款金额 | coupon_refund_fee_$n | 否 | int | 100 | 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠 |
退款代金券使用数量 | coupon_refund_count | 否 | int | 1 | 退款代金券使用数量 |
退款代金券ID | coupon_refund_id_$n | 否 | String(20) | 10000 | 退款代金券ID, $n为下标,从0开始编号 |
举例如下:
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
<sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign>
<result_code><![CDATA[SUCCESS]]></result_code>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
<out_trade_no><![CDATA[1415757673]]></out_trade_no>
<out_refund_no><![CDATA[1415701182]]></out_refund_no>
<refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
<refund_fee>1</refund_fee>
</xml>
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
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 | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
ORDERNOTEXIST | 订单号不存在 | 缺少有效的订单号 | 请检查你的订单号是否正确且是否已支付,未支付的订单不能发起退款 |
REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
FREQUENCY_LIMITED | 频率限制 | 1个月之前的订单申请退款有频率限制 | 该笔退款未受理,请降低频率后重试 |
NOAUTH | 异常IP请求不予受理 | 请求ip异常 | 如果是动态ip,请登录商户平台后台关闭ip安全配置; 如果是静态ip,请确认商户平台配置的请求ip 在不在配的ip列表里 |
CERT_ERROR | 证书校验错误 | 请检查证书是否正确,证书是否过期或作废。 | 请检查证书是否正确,证书是否过期或作废。 |
REFUND_FEE_MISMATCH | 订单金额或退款金额与之前请求不一致,请核实后再试 | 订单金额或退款金额与之前请求不一致,请核实后再试 | 订单金额或退款金额与之前请求不一致,请核实后再试 |
INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 |
ORDER_NOT_READY | 订单处理中,暂时无法退款,请稍后再试 | 订单处理中,暂时无法退款,请稍后再试 | 订单处理中,暂时无法退款,请稍后再试 |
提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。
注意:如果单个支付订单部分退款次数超过20次请使用退款单号查询
如果该订单支付时间超过一年半,需单独使用微信订单号查询或者同时使用微信订单号和微信退款单号查询
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信支付分配的公众账号ID(企业号corpid即为此appid) |
商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5 |
微信订单号 | transaction_id | 四选一 | String(32) | 1217752501201407033233368018 | 微信订单号查询的优先级是: refund_id > out_refund_no > transaction_id > out_trade_no |
商户订单号 | out_trade_no | String(32) | 1217752501201407033233368018 | 商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号 | |
商户退款单号 | out_refund_no | String(64) | 1217752501201407033233368018 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 | |
微信退款单号 | refund_id | String(32) | 1217752501201407033233368018 |
微信生成的退款单号,在申请退款接口有返回 |
|
偏移量 | offset | 否 | int | 15 |
偏移量,当部分退款次数超过10次时可使用,表示返回的查询结果从这个偏移量开始取记录 |
举例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
<out_refund_no></out_refund_no>
<out_trade_no>1415757673</out_trade_no>
<refund_id></refund_id>
<transaction_id></transaction_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信标识,表示接口层的请求结果,并非退款状态。 |
返回信息 | return_msg | 是 | String(128) | OK |
当return_code为FAIL时返回信息为错误原因 ,例如 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
业务结果 | result_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL SUCCESS退款申请接收成功,退款结果以退款状态为准 FAIL |
错误码 | err_code | 是 | String(32) | SYSTEMERROR | 错误码详见第6节 |
错误描述 | err_code_des | 是 | String(128) | 系统错误 | 结果信息描述 |
公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID(企业号corpid即为此appid) |
商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名算法 |
订单总退款次数 | total_refund_count | 否 | int | 35 | 订单总共已发生的部分退款次数,当请求参数传入offset后有返回 |
微信订单号 | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信订单号 |
商户订单号 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号 |
订单金额 | total_fee | 是 | int | 100 | 订单总金额,单位为分,只能为整数,详见支付金额 |
应结订单金额 | settlement_total_fee | 否 | int | 100 | 当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。 |
货币种类 | fee_type | 否 | String(8) | CNY | 订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金支付金额 | cash_fee | 是 | int | 100 | 现金支付金额,单位为分,只能为整数,详见支付金额 |
退款笔数 | refund_count | 是 | int | 1 | 当前返回退款笔数 |
商户退款单号 | out_refund_no_$n | 是 | String(64) | 1217752501201407033233368018 | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 |
微信退款单号 | refund_id_$n | 是 | String(32) | 1217752501201407033233368018 | 微信退款单号 |
退款渠道 | refund_channel_$n | 否 | String(16) | ORIGINAL |
ORIGINAL—原路退款 BALANCE—退回到余额 OTHER_BALANCE—原账户异常退到其他余额账户 OTHER_BANKCARD—原银行卡异常退到其他银行卡 |
申请退款金额 | refund_fee_$n | 是 | int | 100 | 退款总金额,单位为分,可以做部分退款 |
退款总金额 | refund_fee | 是 | int | 100 | 各退款单的退款金额累加 |
代金券退款总金额 | coupon_refund_fee | 是 | int | 100 | 各退款单的代金券退款金额累加 |
退款金额 | settlement_refund_fee_$n | 否 | int | 100 | 退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 |
代金券类型 | coupon_type_$n_$m | 否 | String(8) | CASH |
CASH--充值代金券 NO_CASH---非充值优惠券 开通免充值券功能,并且订单使用了优惠券后有返回(取值:CASH、NO_CASH)。$n为下标,$m为下标,从0开始编号,举例:coupon_type_$0_$1 |
总代金券退款金额 | coupon_refund_fee_$n | 否 | int | 100 | 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠 |
退款代金券使用数量 | coupon_refund_count_$n | 否 | int | 1 | 退款代金券使用数量 ,$n为下标,从0开始编号 |
退款代金券ID | coupon_refund_id_$n_$m | 否 | String(20) | 10000 | 退款代金券ID, $n为下标,$m为下标,从0开始编号 |
单个代金券退款金额 | coupon_refund_fee_$n_$m | 否 | int | 100 | 单个退款代金券支付金额, $n为下标,$m为下标,从0开始编号 |
退款状态 | refund_status_$n | 是 | String(16) | SUCCESS |
退款状态: SUCCESS—退款成功 REFUNDCLOSE—退款关闭,指商户发起退款失败的情况。 PROCESSING—退款处理中 CHANGE—退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。$n为下标,从0开始编号。 |
退款资金来源 | refund_account_$n | 否 | String(30) | REFUND_SOURCE_RECHARGE_FUNDS |
REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款 $n为下标,从0开始编号。 |
退款入账账户 | refund_recv_accout_$n | 是 | String(64) | 招商银行信用卡0403 | 取当前退款单的退款入账方
1)退回银行卡: {银行名称}{卡类型}{卡尾号} 2)退回支付用户零钱: 支付用户零钱 3)退还商户: 商户基本账户 商户结算银行账户 4)退回支付用户零钱通: 支付用户零钱通 |
退款成功时间 | refund_success_time_$n | 否 | String(20) | 2016-07-25 15:26:26 | 退款成功时间,当退款状态为退款成功时有返回。$n为下标,从0开始编号。 |
用户退款金额 | cash_refund_fee | 是 | int | 90 |
退款给用户的金额,不包含所有优惠券金额 |
举例如下:
<xml>
<appid><![CDATA[wx8888888888888888]]></appid>
<mch_id><![CDATA[1900000109]]></mch_id>
<nonce_str><![CDATA[5K8264ILTKCH16CQ2502SI8ZNMTM67VS]]></nonce_str>
<out_trade_no><![CDATA[1217752501201407033233368018]]></out_trade_no>
<refund_count>1</refund_count>
<refund_fee_0>1</refund_fee_0>
<refund_id_0><![CDATA[2008450740201411110000174436]]></refund_id_0>
<refund_status_0><![CDATA[PROCESSING]]></refund_status_0>
<result_code><![CDATA[SUCCESS]]></result_code>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<cash_refund_fee><![CDATA[90]]></cash_refund_fee>
<sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
</xml>
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
SYSTEMERROR | 接口返回错误 | 系统超时 | 请尝试再次调用API。 |
REFUNDNOTEXIST | 退款订单查询失败 | 订单号错误或订单状态不正确 | 请检查订单号是否有误以及订单状态是否正确,如:未支付、已支付未退款 |
INVALID_TRANSACTIONID | 无效transaction_id | 请求参数未按指引进行填写 | 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR | 参数错误 | 请求参数未按指引进行填写 | 请求参数错误,请检查参数再调用退款申请 |
APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 | 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。 |
当商户申请的退款有结果后(退款状态为:退款成功、退款关闭、退款异常),微信会把相关结果发送给商户,商户需要接收处理,并返回应答。
对后台通知交互时,如果微信收到商户的应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功(通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m)。
注意:同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。
推荐的做法是,当收到通知进行处理时,首先检查对应业务数据的状态,判断该通知是否已经处理过,如果没有处理过再进行处理,如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
特别说明:退款结果对重要的数据进行了加密,商户需要用商户密钥进行解密后才能获得结果通知的内容
在申请退款接口中上传参数“notify_url”以开通该功能
如果链接无法访问,商户将无法接收到微信通知。
通知url必须为直接可访问的url,不能携带参数。公网域名必须为https,如果是走专线接入,使用专线NAT IP或者私有回调域名可使用http。示例:notify_url:“https://pay.weixin.qq.com/wxpay/pay.action”
字段名 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信标识,非交易标识,退款是否成功需要解密后查看refund_status来判断 |
返回信息 | return_msg | 是 | String(128) | OK |
当return_code为FAIL时返回信息为错误原因 ,例如 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回:
字段名 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
---|---|---|---|---|---|
公众账号ID |
appid |
是 |
String(32) |
wx8888888888888888 |
微信分配的公众账号ID(企业号corpid即为此appId) |
退款的商户号 |
mch_id |
是 |
String(32) |
1900000109 |
微信支付分配的商户号 |
随机字符串 |
nonce_str |
是 |
String(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
随机字符串,不长于32位。推荐随机数生成算法 |
加密信息 |
req_info |
是 |
String(1024) |
T87GAHG17TGAHG1TGHAHAHA1Y1CIOA9UGJH1GAHV871HAGAGQYQQPOOJMXNBCXBVNMNMAJAA |
加密信息请用商户密钥进行解密,详见解密方式 |
以下为返回的加密字段:
字段名 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
---|---|---|---|---|---|
微信订单号 |
transaction_id |
是 |
String(32) |
1217752501201407033233368018 |
微信订单号 |
商户订单号 |
out_trade_no |
是 |
String(32) |
1217752501201407033233368018 |
商户系统内部的订单号 |
微信退款单号 |
refund_id |
是 |
String(32) |
1217752501201407033233368018 |
微信退款单号 |
商户退款单号 |
out_refund_no |
是 |
String(64) |
1217752501201407033233368018 |
商户退款单号 |
订单金额 |
total_fee |
是 |
int |
100 |
订单总金额,单位为分,只能为整数,详见支付金额 |
应结订单金额 |
settlement_total_fee |
否 |
int |
100 |
当该订单有使用非充值券时,返回此字段。应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。 |
申请退款金额 |
refund_fee |
是 |
int |
100 |
退款总金额,单位为分 |
退款金额 |
settlement_refund_fee |
是 |
int |
100 |
退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 |
退款状态 |
refund_status |
是 |
String(16) |
SUCCESS |
SUCCESS-退款成功 |
退款成功时间 |
success_time |
否 |
String(20) |
2017-12-15 09:46:01 |
资金退款至用户账号的时间,格式2017-12-15 09:46:01 |
退款入账账户 |
refund_recv_accout |
是 |
String(64) |
招商银行信用卡0403 |
取当前退款单的退款入账方 |
1)退回银行卡: |
|||||
{银行名称}{卡类型}{卡尾号} |
|||||
2)退回支付用户零钱: |
|||||
支付用户零钱 |
|||||
3)退还商户: |
|||||
商户基本账户 |
|||||
商户结算银行账户 |
|||||
4)退回支付用户零钱通: |
|||||
支付用户零钱通 |
|||||
退款资金来源 |
refund_account |
是 |
String(30) |
REFUND_SOURCE_RECHARGE_FUNDS |
REFUND_SOURCE_RECHARGE_FUNDS 可用余额退款/基本账户 |
退款发起来源 |
refund_request_source |
是 |
String(30) |
API |
API接口 |
用户退款金额 | cash_refund_fee | 是 | int | 90 |
退款给用户的金额,不包含所有优惠券金额 |
举例如下:
<xml>
<return_code>SUCCESS</return_code>
<appid><![CDATA[wx8888888888888888]]></appid>
<mch_id><![CDATA[1900000109]]></mch_id>
<nonce_str><![CDATA[5K8264ILTKCH16CQ2502SI8ZNMTM67VS]]></nonce_str>
<req_info><![CDATA[T87GAHG17TGAHG1TGHAHAHA1Y1CIOA9UGJH1GAHV871HAGAGQYQQPOOJMXNBCXBVNMNMAJAA]]></req_info>
<return_msg><![CDATA[90]]></return_msg>
</xml>
req_info解密后的示例:
<root>
<out_refund_no><![CDATA[131811191610442717309]]></out_refund_no>
<out_trade_no><![CDATA[71106718111915575302817]]></out_trade_no>
<refund_account><![CDATA[REFUND_SOURCE_RECHARGE_FUNDS]]></refund_account>
<refund_fee><![CDATA[3960]]></refund_fee>
<refund_id><![CDATA[50000408942018111907145868882]]></refund_id>
<refund_recv_accout><![CDATA[支付用户零钱]]></refund_recv_accout>
<refund_request_source><![CDATA[API]]></refund_request_source>
<refund_status><![CDATA[SUCCESS]]></refund_status>
<settlement_refund_fee><![CDATA[3960]]></settlement_refund_fee>
<settlement_total_fee><![CDATA[3960]]></settlement_total_fee>
<success_time><![CDATA[2018-11-19 16:24:13]]></success_time>
<total_fee><![CDATA[3960]]></total_fee>
<transaction_id><![CDATA[4200000215201811190261405420]]></transaction_id>
<cash_refund_fee><![CDATA[90]]></cash_refund_fee>
</root>
发布时间 : 2023-02-28,阅读量:3458 , 分类: 微信支付