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列表里