CloudPay.refund()

支持端：云函数 2.0.2

申请退款

说明

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

注意：

1.交易时间超过一年的订单无法提交退款; 2、微信支付退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交，请不要更换退款单号，请使用原商户退款单号。 3、请求频率限制：150qps，即每秒钟正常的申请退款请求次数不超过150次。错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款申请请求不超过6次 4、每个支付订单的部分退款次数不能超过50次

参数说明

字段名变量名必填类型示例值描述

子商户号sub_mch_id是String(32)1900000109微信支付分配的子商户号

随机字符串nonce_str是String(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS随机字符串，不长于32位。推荐随机数生成算法

微信订单号transaction_id否String(32)1217752501201407033233368018微信订单号。与商户订单号二选一填入。

商户订单号out_trade_no否String(32)1217752501201407033233368018商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-

商户退款单号out_refund_no是String(64)1.21775E+27商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-

订单金额total_fee是Int100订单总金额，单位为分，只能为整数，详见支付金额

申请退款金额refund_fee是Int100退款总金额，单位为分，只能为整数，可部分退款。详见支付金额

货币种类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---可用余额退款

返回值说明

字段名变量名必填类型示例值描述

返回状态码returnCode是String(16)SUCCESSSUCCESS/FAIL

返回信息returnMsg否String(128)签名失败返回信息，如非空，为错误原因。如 签名失败、参数格式校验错误

以下字段在returnCode为SUCCESS的时候有返回

字段名变量名必填类型示例值描述

业务结果result_code是String(16)SUCCESSSUCCESS/FAIL

SUCCESS退款申请接收成功，结果通过退款查询接口查询

FAIL 提交业务失败

错误代码err_code否String(32)SYSTEMERROR列表详见错误码列表

错误代码描述err_code_des否String(128)系统超时结果信息描述

服务商的APPIDappid是String(32)wxd678efh567hg6787服务商商户的APPID

商户号mch_id是String(32)1230000109微信支付分配的商户号

小程序的APPIDsub_appid是String(32)wx8888888888888888微信分配的小程序ID

子商户号sub_mch_id是String(32)1900000109微信支付分配的子商户号

随机字符串nonce_str是String(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS随机字符串，不长于32位

签名sign是String(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS签名，详见签名算法

微信订单号transaction_id是String(32)1217752501201407033233368018微信订单号

商户订单号out_trade_no是String(32)1217752501201407033233368018商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-

商户退款单号out_refund_no是String(64)1217752501201407033233368018商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_-

微信退款单号refund_id是String(32)1217752501201407033233368018微信退款单号

申请退款金额refund_fee是Int100退款总金额,单位为分,可以做部分退款

退款金额settlement_refund_fee否Int100去掉非充值代金券退款金额后的退款金额，退款金额=申请退款金额-非充值代金券退款金额，退款金额

订单金额total_fee是Int100订单总金额，单位为分，只能为整数，详见支付金额

应结订单金额settlement_total_fee否Int100应结订单金额=订单金额-免充值代金券金额，应结订单金额

货币种类fee_type否String(8)CNY订单金额货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型

现金支付金额cash_fee是Int100现金支付金额，单位为分，只能为整数，详见支付金额

现金退款金额cash_refund_fee否Int100现金退款金额，单位为分，只能为整数，详见支付金额

代金券退款总金额coupon_refund_fee否Int100代金券退款金额

退款代金券使用数量coupon_refund_count否Int1退款代金券使用数量

代金券类型coupon_type_$n否String(8)CASHCASH--充值代金券

NO_CASH---非充值代金券

订单使用代金券时有返回(取值：CASH、NO_CASH)。$n为下标,从0开始编号，举例：coupon_type_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_EXISTAPPID不存在参数中缺少APPID请检查APPID是否正确

MCHID_NOT_EXISTMCHID不存在参数中缺少MCHID请检查MCHID是否正确

REQUIRE_POST_METHOD请使用post方法未使用post传递参数请检查请求参数是否通过post方法提交

SIGNERROR签名错误参数签名结果不正确请检查签名参数和方法是否都符合签名算法要求

XML_FORMAT_ERRORXML格式错误XML格式错误请检查XML参数格式是否正确

FREQUENCY_LIMITED频率限制2个月之前的订单申请退款有频率限制该笔退款未受理，请降低频率后重试

NOAUTH异常IP请求不予受理请求ip异常如果是动态ip，请登录商户平台后台关闭ip安全配置;

如果是静态ip，请确认商户平台配置的请求ip 在不在配的ip列表里