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列内外