閱讀(3.9k) 書簽贊(0) 我要糾錯

微信小程序云開發(fā)SDK文檔微信支付·查詢退款

2020-07-27 14:27 更新

CloudPay.queryRefund()

支持端：云函數(shù) 2.0.2

查詢退款

說明

提交退款申請后，通過調(diào)用該接口查詢退款狀態(tài)。退款有一定延時，用零錢支付的退款20分鐘內(nèi)到賬，銀行卡支付的退款3個工作日后重新查詢退款狀態(tài)。注意：如果單個支付訂單部分退款次數(shù)超過20次請使用退款單號查詢* 分頁查詢*

當一個訂單部分退款超過10筆后，商戶用微信訂單號或商戶訂單號調(diào)退款查詢API查詢退款時，默認返回前10筆和total_refund_count（退款單總筆數(shù)）。商戶需要查詢同一訂單下超過10筆的退款單時，可傳入訂單號及offset來查詢，微信支付會返回offset及后面的10筆，以此類推。當商戶傳入的offset超過total_refund_count，則系統(tǒng)會返回報錯PARAM_ERROR。

舉例：

一筆訂單下的退款單有36筆，當商戶想查詢第25筆時，可傳入訂單號及offset=24，微信支付平臺會返回第25筆到第35筆的退款單信息，或商戶可直接傳入退款單號查詢退款

參數(shù)說明

字段名	變量名	必填	類型	示例值	描述
子商戶號	sub_mch_id	是	String(32)	1900000109	微信支付分配的子商戶號
隨機字符串	nonce_str	是	String(32)	5K8264ILTKCH16CQ2502SI8ZNMTM67VS	隨機字符串，不長于32位。推薦隨機數(shù)生成算法
微信訂單號	transaction_id	四選一	String(28)	1217752501201407033233368018	微信訂單號查詢的優(yōu)先級是： refund_id > out_refund_no > transaction_id > out_trade_no
商戶訂單號	out_trade_no	四選一	String(32)	1217752501201407033233368018	商戶系統(tǒng)內(nèi)部訂單號，要求32個字符內(nèi)，只能是數(shù)字、大小寫字母_-
商戶退款單號	out_refund_no	四選一	String(64)	1217752501201407033233368018	商戶系統(tǒng)內(nèi)部的退款單號，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-
微信退款單號	refund_id	四選一	String(32)	1217752501201407033233368018	微信退款單號
偏移量	offset	否	Int	15	偏移量，當部分退款次數(shù)超過10次時可使用，表示返回的查詢結(jié)果從這個偏移量開始取記錄

refund_id、out_refund_no、out_trade_no、transaction_id四個參數(shù)必填一個，如果同時存在優(yōu)先級為： refund_id>out_refund_no>transaction_id>out_trade_no

返回值說明

字段名	變量名	必填	類型	示例值	描述
返回狀態(tài)碼	returnCode	是	String(16)	SUCCESS	SUCCESS/FAIL
返回信息	returnMsg	否	String(128)	簽名失敗	返回信息，如非空，為錯誤原因。如簽名失敗、參數(shù)格式校驗錯誤

以下字段在returnCode為SUCCESS的時候有返回

字段名	變量名	必填	類型	示例值	描述
業(yè)務結(jié)果	result_code	是	String(16)	SUCCESS	SUCCESS/FAIL SUCCESS退款申請接收成功，結(jié)果通過退款查詢接口查詢
錯誤碼	err_code	是	String(32)	SYSTEMERROR	錯誤碼詳見第6節(jié)
錯誤描述	err_code_des	是	String(128)	系統(tǒng)錯誤	結(jié)果信息描述
服務商的APPID	appid	是	String(32)	wxd678efh567hg6787	服務商商戶的APPID
商戶號	mch_id	是	String(32)	1230000109	微信支付分配的商戶號
小程序的APPID	sub_appid	是	String(32)	wx8888888888888888	微信分配的小程序ID
子商戶號	sub_mch_id	是	String(32)	1900000109	微信支付分配的子商戶號
隨機字符串	nonce_str	是	String(32)	5K8264ILTKCH16CQ2502SI8ZNMTM67VS	隨機字符串，不長于32位
簽名	sign	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	簽名，詳見簽名算法
微信訂單號	transaction_id	是	String(32)	1217752501201407033233368018	微信訂單號
商戶訂單號	out_trade_no	是	String(32)	1217752501201407033233368018	商戶系統(tǒng)內(nèi)部訂單號，要求32個字符內(nèi)，只能是數(shù)字、大小寫字母_-
訂單金額	total_fee	是	Int	100	訂單總金額，單位為分，只能為整數(shù)，詳見支付金額
應結(jié)訂單金額	settlement_total_fee	否	Int	100	當訂單使用了免充值型優(yōu)惠券后返回該參數(shù)，應結(jié)訂單金額=訂單金額-免充值優(yōu)惠券金額。
貨幣種類	fee_type	否	String(8)	CNY	訂單金額貨幣類型，符合ISO 4217標準的三位字母代碼，默認人民幣：CNY，其他值列表詳見貨幣類型
現(xiàn)金支付金額	cash_fee	是	Int	100	現(xiàn)金支付金額，單位為分，只能為整數(shù)，詳見支付金額
退款筆數(shù)	refund_count	是	Int	1	當前返回退款筆數(shù)
商戶退款單號	out_refund_no_$n	是	String(64)	1217752501201407033233368018	商戶系統(tǒng)內(nèi)部的退款單號，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-
微信退款單號	refund_id_$n	是	String(32)	1217752501201407033233368018	微信退款單號
退款渠道	refund_channel_$n	否	String(16)	ORIGINAL	ORIGINAL—原路退款 BALANCE—退回到余額 OTHER_BALANCE—原賬戶異常退到其他余額賬戶 OTHER_BANKCARD—原銀行卡異常退到其他銀行卡
訂單總退款次數(shù)	total_refund_count	否	Int	35	訂單總共已發(fā)生的部分退款次數(shù)，當請求參數(shù)傳入offset后有返回
申請退款金額	refund_fee_$n	是	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	代金券退款金額<=退款金額，退款金額-代金券或立減優(yōu)惠退款金額為現(xiàn)金，說明詳見代金券或立減優(yōu)惠
退款代金券使用數(shù)量	coupon_refund_count_$n	否	Int	1	退款代金券使用數(shù)量 ,$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開始編號
退款狀態(tài)	refund_status_$n	是	String(16)	SUCCESS	退款狀態(tài)：SUCCESS—退款成功 REFUNDCLOSE—退款關(guān)閉。 PROCESSING—退款處理中 CHANGE—退款異常，退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了，導致原路退款銀行卡失敗，可前往商戶平臺（pay.weixin.qq.com）-交易中心，手動處理此筆退款。$n為下標，從0開始編號。
退款資金來源	refund_account_$n	否	String(30)	REFUND_SOURCE_RECHARGE_FUNDS	REFUND_SOURCE_RECHARGE_FUNDS---可用余額退款/基本賬戶 REFUND_SOURCE_UNSETTLED_FUNDS---未結(jié)算資金退款 $n為下標，從0開始編號。
退款入賬賬戶	refund_recv_accout_$n	是	String(64)	招商銀行信用卡0403	取當前退款單的退款入賬方 1）退回銀行卡： {銀行名稱}{卡類型}{卡尾號} 2）退回支付用戶零錢: 支付用戶零錢 3）退還商戶: 商戶基本賬戶商戶結(jié)算銀行賬戶 4）退回支付用戶零錢通: 支付用戶零錢通
退款成功時間	refund_success_time_$n	否	String(20)	2016-07-25 15:26:26	退款成功時間，當退款狀態(tài)為退款成功時有返回。$n為下標，從0開始編號。

錯誤碼

名稱	描述	原因	解決方案
SYSTEMERROR	接口返回錯誤	系統(tǒng)超時	請嘗試再次掉調(diào)用API。
REFUNDNOTEXIST	退款訂單查詢失敗	訂單號錯誤或訂單狀態(tài)不正確	請檢查訂單號是否有誤以及訂單狀態(tài)是否正確，如：未支付、已支付未退款
INVALID_TRANSACTIONID	無效transaction_id	請求參數(shù)未按指引進行填寫	請求參數(shù)錯誤，檢查原交易號是否存在或發(fā)起支付交易接口返回失敗
PARAM_ERROR	參數(shù)錯誤	請求參數(shù)未按指引進行填寫	請求參數(shù)錯誤，請檢查參數(shù)再調(diào)用退款申請
APPID_NOT_EXIST	APPID不存在	參數(shù)中缺少APPID	請檢查APPID是否正確
MCHID_NOT_EXIST	MCHID不存在	參數(shù)中缺少MCHID	請檢查MCHID是否正確
REQUIRE_POST_METHOD	請使用post方法	未使用post傳遞參數(shù)	請檢查請求參數(shù)是否通過post方法提交
SIGNERROR	簽名錯誤	參數(shù)簽名結(jié)果不正確	請檢查簽名參數(shù)和方法是否都符合簽名算法要求
XML_FORMAT_ERROR	XML格式錯誤	XML格式錯誤	請檢查XML參數(shù)格式是否正確

以上內(nèi)容是否對您有幫助：

← 微信小程序云開發(fā)SDK文檔微信支付·申請退款

微信小程序云開發(fā)SDK文檔微信支付·下載對賬單 →

寫筆記

我要補充

微信小程序云開發(fā)SDK文檔 微信支付·查詢退款

CloudPay.queryRefund()

說明

參數(shù)說明

返回值說明

錯誤碼

推薦文章

推薦教程

推薦課程

微信小程序云開發(fā)SDK文檔微信支付·查詢退款