查询单笔退款(通过商户退款单号)
更新时间:2025.01.09提交退款申请后,推荐每间隔1分钟调用该接口查询一次退款状态,若超过5分钟仍是退款处理中状态,建议开始逐步衰减查询频率(比如之后间隔5分钟、10分钟、20分钟、30分钟……查询一次)。
退款有一定延时,零钱支付的订单退款一般5分钟内到账,银行卡支付的订单退款一般1-3个工作日到账。
同一商户号查询退款频率限制为300qps,如返回FREQUENCY_LIMITED频率限制报错可间隔1分钟再重试查询。
接口说明
支持商户:【普通商户】
请求方式:【GET】/v3/refund/domestic/refunds/{out_refund_no}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
out_refund_no 必填 string(64)
【商户退款单号】 商户申请退款时传入的商户系统内部退款单号。
请求示例
需配合微信支付工具库 WXPayUtility 使用,请参考 Java
1package com.java.demo; 2 3import com.google.gson.annotations.Expose; 4import com.google.gson.annotations.SerializedName; 5import com.java.utils.WXPayUtility; // 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/merchant/4014931831 6import java.io.IOException; 7import java.io.UncheckedIOException; 8import java.security.PrivateKey; 9import java.security.PublicKey; 10import java.util.ArrayList; 11import java.util.HashMap; 12import java.util.List; 13import java.util.Map; 14import okhttp3.MediaType; 15import okhttp3.OkHttpClient; 16import okhttp3.Request; 17import okhttp3.RequestBody; 18import okhttp3.Response; 19 20/** 21 * 查询单笔退款(通过商户退款单号) 22 */ 23public class QueryByOutRefundNo { 24 private static String HOST = "https://api.mch.weixin.qq.com"; 25 private static String METHOD = "GET"; 26 private static String PATH = "/v3/refund/domestic/refunds/{out_refund_no}"; 27 28 public static void main(String[] args) { 29 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 30 QueryByOutRefundNo client = new QueryByOutRefundNo( 31 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013053053 33 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 34 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013038816 35 "填入 微信支付公钥文件路径" // 微信支付公钥文件路径,本地文件路径 36 ); 37 38 QueryByOutRefundNoRequest request = new QueryByOutRefundNoRequest(); 39 request.outRefundNo = "1217752501201407033233368018"; 40 try { 41 Refund response = client.run(request); 42 43 // TODO: 请求成功,继续业务逻辑 44 System.out.println(response); 45 } catch (WXPayUtility.ApiException e) { 46 // TODO: 请求失败,根据状态码执行不同的逻辑 47 e.printStackTrace(); 48 } 49 } 50 51 public Refund run(QueryByOutRefundNoRequest request) { 52 String uri = PATH.replace("{out_refund_no}", WXPayUtility.urlEncode(request.outRefundNo)); 53 54 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 55 reqBuilder.addHeader("Accept", "application/json"); 56 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 57 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 58 reqBuilder.method(METHOD, null); 59 Request httpRequest = reqBuilder.build(); 60 61 // 发送HTTP请求 62 OkHttpClient client = new OkHttpClient.Builder().build(); 63 try (Response httpResponse = client.newCall(httpRequest).execute()) { 64 String respBody = WXPayUtility.extractBody(httpResponse); 65 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 66 // 2XX 成功,验证应答签名 67 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 68 httpResponse.headers(), respBody); 69 70 // 从HTTP应答报文构建返回数据 71 return WXPayUtility.fromJson(respBody, Refund.class); 72 } else { 73 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 74 } 75 } catch (IOException e) { 76 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 77 } 78 } 79 80 private final String mchid; 81 private final String certificateSerialNo; 82 private final PrivateKey privateKey; 83 private final String wechatPayPublicKeyId; 84 private final PublicKey wechatPayPublicKey; 85 86 public QueryByOutRefundNo(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 87 this.mchid = mchid; 88 this.certificateSerialNo = certificateSerialNo; 89 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 90 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 91 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 92 } 93 94 public enum Status { 95 @SerializedName("SUCCESS") 96 SUCCESS, 97 @SerializedName("CLOSED") 98 CLOSED, 99 @SerializedName("PROCESSING") 100 PROCESSING, 101 @SerializedName("ABNORMAL") 102 ABNORMAL 103 } 104 105 public enum Account { 106 @SerializedName("AVAILABLE") 107 AVAILABLE, 108 @SerializedName("UNAVAILABLE") 109 UNAVAILABLE 110 } 111 112 public enum PromotionType { 113 @SerializedName("COUPON") 114 COUPON, 115 @SerializedName("DISCOUNT") 116 DISCOUNT 117 } 118 119 public static class Refund { 120 @SerializedName("refund_id") 121 public String refundId; 122 123 @SerializedName("out_refund_no") 124 public String outRefundNo; 125 126 @SerializedName("transaction_id") 127 public String transactionId; 128 129 @SerializedName("out_trade_no") 130 public String outTradeNo; 131 132 @SerializedName("channel") 133 public Channel channel; 134 135 @SerializedName("user_received_account") 136 public String userReceivedAccount; 137 138 @SerializedName("success_time") 139 public String successTime; 140 141 @SerializedName("create_time") 142 public String createTime; 143 144 @SerializedName("status") 145 public Status status; 146 147 @SerializedName("funds_account") 148 public FundsAccount fundsAccount; 149 150 @SerializedName("amount") 151 public Amount amount; 152 153 @SerializedName("promotion_detail") 154 public List<Promotion> promotionDetail; 155 } 156 157 public static class GoodsDetail { 158 @SerializedName("merchant_goods_id") 159 public String merchantGoodsId; 160 161 @SerializedName("wechatpay_goods_id") 162 public String wechatpayGoodsId; 163 164 @SerializedName("goods_name") 165 public String goodsName; 166 167 @SerializedName("unit_price") 168 public Long unitPrice; 169 170 @SerializedName("refund_amount") 171 public Long refundAmount; 172 173 @SerializedName("refund_quantity") 174 public Integer refundQuantity; 175 } 176 177 public static class QueryByOutRefundNoRequest { 178 @SerializedName("out_refund_no") 179 @Expose(serialize = false) 180 public String outRefundNo; 181 } 182 183 public enum Channel { 184 @SerializedName("ORIGINAL") 185 ORIGINAL, 186 @SerializedName("BALANCE") 187 BALANCE, 188 @SerializedName("OTHER_BALANCE") 189 OTHER_BALANCE, 190 @SerializedName("OTHER_BANKCARD") 191 OTHER_BANKCARD 192 } 193 194 public static class Amount { 195 @SerializedName("total") 196 public Long total; 197 198 @SerializedName("refund") 199 public Long refund; 200 201 @SerializedName("from") 202 public List<FundsFromItem> from; 203 204 @SerializedName("payer_total") 205 public Long payerTotal; 206 207 @SerializedName("payer_refund") 208 public Long payerRefund; 209 210 @SerializedName("settlement_refund") 211 public Long settlementRefund; 212 213 @SerializedName("settlement_total") 214 public Long settlementTotal; 215 216 @SerializedName("discount_refund") 217 public Long discountRefund; 218 219 @SerializedName("currency") 220 public String currency; 221 222 @SerializedName("refund_fee") 223 public Long refundFee; 224 } 225 226 public static class FundsFromItem { 227 @SerializedName("account") 228 public Account account; 229 230 @SerializedName("amount") 231 public Long amount; 232 } 233 234 public enum FundsAccount { 235 @SerializedName("UNSETTLED") 236 UNSETTLED, 237 @SerializedName("AVAILABLE") 238 AVAILABLE, 239 @SerializedName("UNAVAILABLE") 240 UNAVAILABLE, 241 @SerializedName("OPERATION") 242 OPERATION, 243 @SerializedName("BASIC") 244 BASIC, 245 @SerializedName("ECNY_BASIC") 246 ECNY_BASIC 247 } 248 249 public static class Promotion { 250 @SerializedName("promotion_id") 251 public String promotionId; 252 253 @SerializedName("scope") 254 public PromotionScope scope; 255 256 @SerializedName("type") 257 public PromotionType type; 258 259 @SerializedName("amount") 260 public Long amount; 261 262 @SerializedName("refund_amount") 263 public Long refundAmount; 264 265 @SerializedName("goods_detail") 266 public List<GoodsDetail> goodsDetail; 267 } 268 269 public enum PromotionScope { 270 @SerializedName("GLOBAL") 271 GLOBAL, 272 @SerializedName("SINGLE") 273 SINGLE 274 } 275}
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "demo/wxpay_utility"// 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/merchant/4015119334 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "strings" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 14 config, err := wxpay_utility.CreateMchConfig( 15 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/merchant/4013070756 16 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013053053 17 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 18 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013038816 19 "填入 微信支付公钥文件路径", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &QueryByOutRefundNoRequest{ 27 OutRefundNo: wxpay_utility.String("1217752501201407033233368018"), 28 } 29 30 response, err := QueryByOutRefundNo(config, request) 31 if err != nil { 32 fmt.Printf("请求失败: %+v\n", err) 33 // TODO: 请求失败,根据状态码执行不同的处理 34 return 35 } 36 37 // TODO: 请求成功,继续业务逻辑 38 fmt.Printf("请求成功: %+v\n", response) 39} 40 41func QueryByOutRefundNo(config *wxpay_utility.MchConfig, request *QueryByOutRefundNoRequest) (response *Refund, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "GET" 45 path = "/v3/refund/domestic/refunds/{out_refund_no}" 46 ) 47 48 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 49 if err != nil { 50 return nil, err 51 } 52 reqUrl.Path = strings.Replace(reqUrl.Path, "{out_refund_no}", url.PathEscape(*request.OutRefundNo), -1) 53 query := reqUrl.Query() 54 reqUrl.RawQuery = query.Encode() 55 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 56 if err != nil { 57 return nil, err 58 } 59 httpRequest.Header.Set("Accept", "application/json") 60 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 61 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 62 if err != nil { 63 return nil, err 64 } 65 httpRequest.Header.Set("Authorization", authorization) 66 67 client := &http.Client{} 68 httpResponse, err := client.Do(httpRequest) 69 if err != nil { 70 return nil, err 71 } 72 73 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 74 if err != nil { 75 return nil, err 76 } 77 78 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 79 // 2XX 成功,验证应答签名 80 err = wxpay_utility.ValidateResponse( 81 config.WechatPayPublicKeyId(), 82 config.WechatPayPublicKey(), 83 &httpResponse.Header, 84 respBody, 85 ) 86 if err != nil { 87 return nil, err 88 } 89 90 if err := json.Unmarshal(respBody, response); err != nil { 91 return nil, err 92 } 93 94 return response, nil 95 } else { 96 return nil, &wxpay_utility.ApiException{ 97 StatusCode: httpResponse.StatusCode, 98 Header: httpResponse.Header, 99 Body: respBody, 100 } 101 } 102} 103 104type Status string 105 106func (e Status) Ptr() *Status { 107 return &e 108} 109 110const ( 111 STATUS_SUCCESS Status = "SUCCESS" 112 STATUS_CLOSED Status = "CLOSED" 113 STATUS_PROCESSING Status = "PROCESSING" 114 STATUS_ABNORMAL Status = "ABNORMAL" 115) 116 117type Account string 118 119func (e Account) Ptr() *Account { 120 return &e 121} 122 123const ( 124 ACCOUNT_AVAILABLE Account = "AVAILABLE" 125 ACCOUNT_UNAVAILABLE Account = "UNAVAILABLE" 126) 127 128type PromotionType string 129 130func (e PromotionType) Ptr() *PromotionType { 131 return &e 132} 133 134const ( 135 PROMOTIONTYPE_COUPON PromotionType = "COUPON" 136 PROMOTIONTYPE_DISCOUNT PromotionType = "DISCOUNT" 137) 138 139type Refund struct { 140 RefundId *string `json:"refund_id,omitempty"` 141 OutRefundNo *string `json:"out_refund_no,omitempty"` 142 TransactionId *string `json:"transaction_id,omitempty"` 143 OutTradeNo *string `json:"out_trade_no,omitempty"` 144 Channel *Channel `json:"channel,omitempty"` 145 UserReceivedAccount *string `json:"user_received_account,omitempty"` 146 SuccessTime *string `json:"success_time,omitempty"` 147 CreateTime *string `json:"create_time,omitempty"` 148 Status *Status `json:"status,omitempty"` 149 FundsAccount *FundsAccount `json:"funds_account,omitempty"` 150 Amount *Amount `json:"amount,omitempty"` 151 PromotionDetail []Promotion `json:"promotion_detail,omitempty"` 152} 153 154type GoodsDetail struct { 155 MerchantGoodsId *string `json:"merchant_goods_id,omitempty"` 156 WechatpayGoodsId *string `json:"wechatpay_goods_id,omitempty"` 157 GoodsName *string `json:"goods_name,omitempty"` 158 UnitPrice *int64 `json:"unit_price,omitempty"` 159 RefundAmount *int64 `json:"refund_amount,omitempty"` 160 RefundQuantity *int64 `json:"refund_quantity,omitempty"` 161} 162 163type QueryByOutRefundNoRequest struct { 164 OutRefundNo *string `json:"out_refund_no,omitempty"` 165} 166 167func (o *QueryByOutRefundNoRequest) MarshalJSON() ([]byte, error) { 168 type Alias QueryByOutRefundNoRequest 169 a := &struct { 170 OutRefundNo *string `json:"out_refund_no,omitempty"` 171 *Alias 172 }{ 173 // 序列化时移除非 Body 字段 174 OutRefundNo: nil, 175 Alias: (*Alias)(o), 176 } 177 return json.Marshal(a) 178} 179 180type Channel string 181 182func (e Channel) Ptr() *Channel { 183 return &e 184} 185 186const ( 187 CHANNEL_ORIGINAL Channel = "ORIGINAL" 188 CHANNEL_BALANCE Channel = "BALANCE" 189 CHANNEL_OTHER_BALANCE Channel = "OTHER_BALANCE" 190 CHANNEL_OTHER_BANKCARD Channel = "OTHER_BANKCARD" 191) 192 193type Amount struct { 194 Total *int64 `json:"total,omitempty"` 195 Refund *int64 `json:"refund,omitempty"` 196 From []FundsFromItem `json:"from,omitempty"` 197 PayerTotal *int64 `json:"payer_total,omitempty"` 198 PayerRefund *int64 `json:"payer_refund,omitempty"` 199 SettlementRefund *int64 `json:"settlement_refund,omitempty"` 200 SettlementTotal *int64 `json:"settlement_total,omitempty"` 201 DiscountRefund *int64 `json:"discount_refund,omitempty"` 202 Currency *string `json:"currency,omitempty"` 203 RefundFee *int64 `json:"refund_fee,omitempty"` 204} 205 206type FundsFromItem struct { 207 Account *Account `json:"account,omitempty"` 208 Amount *int64 `json:"amount,omitempty"` 209} 210 211type FundsAccount string 212 213func (e FundsAccount) Ptr() *FundsAccount { 214 return &e 215} 216 217const ( 218 FUNDSACCOUNT_UNSETTLED FundsAccount = "UNSETTLED" 219 FUNDSACCOUNT_AVAILABLE FundsAccount = "AVAILABLE" 220 FUNDSACCOUNT_UNAVAILABLE FundsAccount = "UNAVAILABLE" 221 FUNDSACCOUNT_OPERATION FundsAccount = "OPERATION" 222 FUNDSACCOUNT_BASIC FundsAccount = "BASIC" 223 FUNDSACCOUNT_ECNY_BASIC FundsAccount = "ECNY_BASIC" 224) 225 226type Promotion struct { 227 PromotionId *string `json:"promotion_id,omitempty"` 228 Scope *PromotionScope `json:"scope,omitempty"` 229 Type *PromotionType `json:"type,omitempty"` 230 Amount *int64 `json:"amount,omitempty"` 231 RefundAmount *int64 `json:"refund_amount,omitempty"` 232 GoodsDetail []GoodsDetail `json:"goods_detail,omitempty"` 233} 234 235type PromotionScope string 236 237func (e PromotionScope) Ptr() *PromotionScope { 238 return &e 239} 240 241const ( 242 PROMOTIONSCOPE_GLOBAL PromotionScope = "GLOBAL" 243 PROMOTIONSCOPE_SINGLE PromotionScope = "SINGLE" 244)
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/1217752501201407033233368018 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json"
应答参数
|
refund_id 必填 string(32)
【微信支付退款单号】申请退款受理成功时,该笔退款单在微信支付侧生成的唯一标识。
out_refund_no 必填 string(64)
【商户退款单号】商户申请退款时传入的商户系统内部退款单号。
transaction_id 必填 string(32)
【微信支付订单号】微信支付侧订单的唯一标识。
out_trade_no 必填 string(32)
【商户订单号】 商户下单时传入的商户系统内部订单号。
channel 必填 string
【退款渠道】 订单退款渠道
以下枚举:
ORIGINAL
: 原路退款BALANCE
: 退回到余额OTHER_BALANCE
: 原账户异常退到其他余额账户OTHER_BANKCARD
: 原银行卡异常退到其他银行卡(发起异常退款成功后返回)
user_received_account 必填 string(64)
【退款入账账户】 当前退款单的退款入账方,取值有以下几种情况:
1)退回银行卡:{银行名称}{卡类型}{卡尾号}
2)退回支付用户零钱:支付用户零钱
3)退还商户:商户基本账户商户结算银行账户
4)退回支付用户零钱通:支付用户零钱通
5)退回支付用户银行电子账户:支付用户银行电子账户
6)退回支付用户零花钱:支付用户零花钱
7)退回用户经营账户:用户经营账户
8)退回支付用户来华零钱包:支付用户来华零钱包
9)退回企业支付商户:企业支付商户
success_time 选填 string(64)
【退款成功时间】
1、定义:退款成功的时间,该字段在退款状态status为SUCCESS(退款成功)时返回。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。
create_time 必填 string(64)
【退款创建时间】
1、定义:提交退款申请成功,微信受理退款申请单的时间。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
status 必填 string
【退款状态】退款单的退款处理状态。
SUCCESS
: 退款成功CLOSED
: 退款关闭PROCESSING
: 退款处理中ABNORMAL
: 退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台-交易中心,手动处理此笔退款,可参考: 退款异常的处理,或者通过发起异常退款接口进行处理。
注:状态流转说明请参考状态流转图
funds_account 必填 string
【资金账户】 退款所使用资金对应的资金账户类型
UNSETTLED
: 未结算资金AVAILABLE
: 可用余额UNAVAILABLE
: 不可用余额OPERATION
: 运营账户BASIC
: 基本账户(含可用余额和不可用余额)ECNY_BASIC
: 数字人民币基本账户
amount 必填 object
【金额信息】订单退款金额信息
属性 | |||||
total 必填 integer 【订单金额】 订单总金额,单位为分 refund 必填 integer 【退款金额】退款金额,单位为分,只能为整数,可以做部分退款,不能超过原订单支付金额。 from 选填 array[object] 【退款出资账户及金额】 退款出资的账户类型及金额信息,若申请退款时未传该参数,则不会返回。
payer_total 必填 integer 【用户实际支付金额】 用户现金支付金额,整型,单位为分,例如10元订单用户使用了2元全场代金券,则该金额为用户实际支付的8元。 payer_refund 必填 integer 【用户退款金额】 指用户实际收到的现金退款金额,数据类型为整型,单位为分。例如在一个10元的订单中,用户使用了2元的全场代金券,若商户申请退款5元,则用户将收到4元的现金退款(即该字段所示金额)和1元的代金券退款。 settlement_refund 必填 integer 【应结退款金额】 去掉免充值代金券退款金额后的退款金额,整型,单位为分,例如10元订单用户使用了2元全场代金券(一张免充值1元 + 一张预充值1元),商户申请退款5元,则该金额为 退款金额5元 - 0.5元免充值代金券退款金额 = 4.5元。 settlement_total 必填 integer 【应结订单金额】 分,例如10元订单用户使用了2元全场代金券(一张免充值1元 + 一张预充值1元),则该金额为 订单金额10元 - 免充值代金券金额1元 = 9元。去除免充值代金券金额后的订单金额,整型,单位为 discount_refund 必填 integer 【优惠退款金额】 申请退款后用户收到的代金券退款金额,整型,单位为分,例如10元订单用户使用了2元全场代金券,商户申请退款5元,用户收到的是4元现金 + 1元代金券退款金额(该字段) 。 currency 必填 string(16) 【退款币种】 固定返回:CNY,代表人民币。 refund_fee 选填 integer 【手续费退款金额】 订单退款时退还的手续费金额,整型,单位为分,例如一笔100元的订单收了0.6元手续费,商户申请退款50元,该金额为等比退还的0.3元手续费。 |
promotion_detail 选填 array[object]
【优惠退款详情】 订单各个代金券的退款详情,订单使用了代金券且代金券发生退款时返回。
属性 | |||||
promotion_id 必填 string(32) 【券ID】代金券id,单张代金券的编号 scope 必填 string 【优惠范围】优惠活动中代金券的适用范围,分为两种类型: type 必填 string 【优惠类型】代金券资金类型,优惠活动中代金券的结算资金类型,分为两种类型: amount 必填 integer 【代金券面额】 代金券优惠的金额 refund_amount 必填 integer 【优惠退款金额】 代金券退款的金额 goods_detail 选填 array[object] 【退款商品】 指定商品退款时传的退款商品信息。
|
应答示例
200 OK
1{ 2 "refund_id" : "50000000382019052709732678859", 3 "out_refund_no" : "1217752501201407033233368018", 4 "transaction_id" : "1217752501201407033233368018", 5 "out_trade_no" : "1217752501201407033233368018", 6 "channel" : "ORIGINAL", 7 "user_received_account" : "招商银行信用卡0403", 8 "success_time" : "2020-12-01T16:18:12+08:00", 9 "create_time" : "2020-12-01T16:18:12+08:00", 10 "status" : "SUCCESS", 11 "funds_account" : "UNSETTLED", 12 "amount" : { 13 "total" : 100, 14 "refund" : 100, 15 "from" : [ 16 { 17 "account" : "AVAILABLE", 18 "amount" : 444 19 } 20 ], 21 "payer_total" : 90, 22 "payer_refund" : 90, 23 "settlement_refund" : 100, 24 "settlement_total" : 100, 25 "discount_refund" : 10, 26 "currency" : "CNY", 27 "refund_fee" : 100 28 }, 29 "promotion_detail" : [ 30 { 31 "promotion_id" : "109519", 32 "scope" : "GLOBAL", 33 "type" : "COUPON", 34 "amount" : 5, 35 "refund_amount" : 100, 36 "goods_detail" : [ 37 { 38 "merchant_goods_id" : "1217752501201407033233368018", 39 "wechatpay_goods_id" : "1001", 40 "goods_name" : "iPhone6s 16G", 41 "unit_price" : 528800, 42 "refund_amount" : 528800, 43 "refund_quantity" : 1 44 } 45 ] 46 } 47 ] 48}
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名 |
404 | MCH_NOT_EXISTS | MCHID不存在 | 请检查商户号是否正确,商户号获取方式请参考普通商户模式开发必要参数说明 |
404 | RESOURCE_NOT_EXISTS | 退款单不存在 | 请检查商户退款单号是否有误以及订单状态是否正确,如:未支付 |
500 | SYSTEM_ERROR | 系统超时 | 请不要更换商户退款单号,请使用相同参数再次调用API。 |