申请退款

应用场景

当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,微信支付将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家帐号上。

注意:

1、交易时间超过一年的订单无法提交退款;

2、微信支付退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。总退款金额不能超过用户实际支付金额。 一笔退款失败后重新提交,请不要更换退款单号,请使用原商户退款单号。

接口地址

接口链接:https://api.mch.weixin.qq.com/secapi/pay/refund

是否需要证书

请求需要双向证书。 详见证书使用

请求参数

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(32) wx8888888888888888 微信开放平台审核通过的应用APPID
商户号 mch_id String(32) 1900000109 微信支付分配的商户号
设备号 device_info String(32) 013467007045764 终端设备号
随机字符串 nonce_str String(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 随机字符串,不长于32位。推荐随机数生成算法
签名 sign String(32) C380BEC2BFD727A4B6845133519F3AD6 签名,详见签名生成算法
微信订单号 transaction_id 二选一 String(28) 1217752501201407033233368018 微信生成的订单号,在支付通知中有返回
商户订单号 out_trade_no String(32) 1217752501201407033233368018 商户侧传给微信的订单号
商户退款单号 out_refund_no String(32) 1217752501201407033233368018 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
总金额 total_fee Int 100 订单总金额,单位为分,只能为整数,详见支付金额
退款金额 refund_fee Int 100 退款总金额,订单总金额,单位为分,只能为整数,详见支付金额
货币种类 refund_fee_type String(8) CNY 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
操作员 op_user_id String(32) 1900000109 操作员帐号, 默认为商户号
退款资金来源 refund_account String(30) REFUND_SOURCE_RECHARGE_FUNDS

仅针对老资金流商户使用

REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款(默认使用未结算资金退款)

REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款

举例如下:

<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <mch_id>10000100</mch_id>
   <nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
   <op_user_id>10000100</op_user_id>
   <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></transaction_id>
   <sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>

返回结果

字段名 变量名 必填 类型 示例值 描述
返回状态码 return_code String(16) SUCCESS SUCCESS/FAIL
返回信息 return_msg String(128) 签名失败

返回信息,如非空,为错误原因

签名失败

参数格式校验错误

以下字段在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 微信开放平台审核通过的应用APPID
商户号 mch_id String(32) 1900000109 微信支付分配的商户号
设备号 device_info String(32) 013467007045764 微信支付分配的终端设备号,与下单一致
随机字符串 nonce_str String(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 随机字符串,不长于32位
签名 sign String(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 签名,详见签名算法
微信订单号 transaction_id String(28) 1217752501201407033233368018 微信订单号
商户订单号 out_trade_no String(32) 1217752501201407033233368018 商户系统内部的订单号
商户退款单号 out_refund_no String(32) 1217752501201407033233368018 商户退款单号
微信退款单号 refund_id String(28) 1217752501201407033233368018 微信退款单号
退款渠道 refund_channel String(16) ORIGINAL

ORIGINAL—原路退款

BALANCE—退回到余额

退款金额 refund_fee Int 100 退款总金额,单位为分,可以做部分退款
订单总金额 total_fee Int 100 订单总金额,单位为分,只能为整数,详见支付金额
订单金额货币种类 fee_type String(8) CNY 订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
现金支付金额 cash_fee Int 100 现金支付金额,单位为分,只能为整数,详见支付金额
现金退款金额 cash_refund_fee Int 100 现金退款金额,单位为分,只能为整数,详见支付金额
代金券或立减优惠退款金额 coupon_refund_fee Int 100 代金券或立减优惠退款金额=订单金额-现金退款金额,注意:立减优惠金额不会退回
代金券或立减优惠使用数量 coupon_refund_count Int 1 代金券或立减优惠使用数量
代金券或立减优惠ID coupon_refund_id String(20) 10000  代金券或立减优惠ID

举例如下:

<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_channel><![CDATA[]]></refund_channel>
   <refund_fee>1</refund_fee>
   <coupon_refund_fee>0</coupon_refund_fee>
</xml>

错误码

名称 描述 原因 解决方案
SYSTEMERROR 接口返回错误 系统超时 请不要更换商户退款单号,请使用相同参数再次调用API。
USER_ACCOUNT_ABNORMAL 退款请求失败 用户帐号注销 此状态代表退款申请失败,商户可自行处理退款。
NOTENOUGH 余额不足 商户可用退款余额不足 此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。
INVALID_TRANSACTIONID 无效transaction_id 请求参数未按指引进行填写 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败
PARAM_ERROR 参数错误 请求参数未按指引进行填写 请求参数错误,请重新检查再调用退款申请
APPID_NOT_EXIST APPID不存在 参数中缺少APPID 请检查APPID是否正确
MCHID_NOT_EXIST MCHID不存在 参数中缺少MCHID 请检查MCHID是否正确
APPID_MCHID_NOT_MATCH appid和mch_id不匹配 appid和mch_id不匹配 请确认appid和mch_id是否匹配
REQUIRE_POST_METHOD 请使用post方法 未使用post传递参数  请检查请求参数是否通过post方法提交
SIGNERROR 签名错误 参数签名结果不正确 请检查签名参数和方法是否都符合签名算法要求
XML_FORMAT_ERROR XML格式错误 XML格式错误 请检查XML参数格式是否正确