请求补差回退
更新时间:2024.11.04订单发送退款的时候,可以对补差成功的补差单发起回退。
补差回退以原补差单位依据,支持多次回退,申请回退总金额不能超过补差金额。
此接口采用同步处理模式,即在接收到商户请求后,会实时返回处理结果。
一笔微信退款单只允许补差回退一次。
系统异常(如返回SYSTEM_ERROR),请使用相同参数稍后重新调用,请务必用原商户补差回退单号和原参数来重入此接口。
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/ecommerce/subsidies/return
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
body 包体参数
sub_mchid 必填 string(32)
【电商平台二级商户号】补差的电商平台二级商户,填写微信支付分配的商户号
out_order_no 必填 string(64)
【商户补差回退单号】商户系统内部的补差回退单号,在商户系统内部唯一,同一补差回退单号多次请求等同一次。只能是数字、大小写字母_-|*@
transaction_id 必填 string(64)
【微信订单号】微信支付订单号
refund_id 选填 string(64)
【微信退款单号】微信退款单号,微信系统退款返回的唯一标识。因用户账户异常而无法退款时可不传,其他情况必传
amount 必填 integer
【补差回退金额】补差回退金额,单位为分,只能为整数,不能超过补差单的补差金额。如果指定了出资账户及金额,则必须为所有出资账户的金额之和
description 必填 string(80)
【补差回退描述】补差回退描述,查询的时候原样带回来
subsidy_id 选填 string(64)
【微信补差单号】微信补差单号,微信系统返回的唯一标识
from 选填 array[ReturnFrom]
【回退出资账户及金额】回退需要从指定账户出资时,传递此参数指定出资金额(币种的最小单位,只能为整数)。 当前仅支持从一个账户出资。使用场景需要满足以下条件:1、本次回退金额和已回退金额之和不超过该补差单的补差金额;2、本次回退的金额不超过指定的账户的实际可用资金
属性 | |
account 选填 string 【出资账户类型】下面枚举值多选一。 枚举值: AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 可选取值:
amount 选填 integer 【出资金额】对应账户出资金额 |
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/ecommerce/subsidies/return \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "sub_mchid" : "1900000109", 8 "out_order_no" : "P20150806125346", 9 "transaction_id" : "4208450740201411110007820472", 10 "refund_id" : "3008450740201411110007820472", 11 "amount" : 10, 12 "description" : "测试备注", 13 "subsidy_id" : "3008450740201411110007820472", 14 "from" : [ 15 { 16 "account" : "AVAILABLE", 17 "amount" : 10 18 } 19 ] 20 }' 21
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 请求补差回退 24 */ 25public class ReturnSubsidy { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/ecommerce/subsidies/return"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 ReturnSubsidy client = new ReturnSubsidy( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 SubsidiesReturnRequest request = new SubsidiesReturnRequest(); 41 request.subMchid = "1900000109"; 42 request.outOrderNo = "P20150806125346"; 43 request.transactionId = "4208450740201411110007820472"; 44 request.refundId = "3008450740201411110007820472"; 45 request.amount = 10L; 46 request.description = "测试备注"; 47 request.subsidyId = "3008450740201411110007820472"; 48 request.from = new ArrayList<>(); 49 { 50 ReturnFrom fromItem = new ReturnFrom(); 51 fromItem.account = ReturnAccount.AVAILABLE; 52 fromItem.amount = 10L; 53 request.from.add(fromItem); 54 }; 55 try { 56 SubsidiesReturnEntity response = client.run(request); 57 // TODO: 请求成功,继续业务逻辑 58 System.out.println(response); 59 } catch (WXPayUtility.ApiException e) { 60 // TODO: 请求失败,根据状态码执行不同的逻辑 61 e.printStackTrace(); 62 } 63 } 64 65 public SubsidiesReturnEntity run(SubsidiesReturnRequest request) { 66 String uri = PATH; 67 String reqBody = WXPayUtility.toJson(request); 68 69 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 70 reqBuilder.addHeader("Accept", "application/json"); 71 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 72 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 73 reqBuilder.addHeader("Content-Type", "application/json"); 74 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 75 reqBuilder.method(METHOD, requestBody); 76 Request httpRequest = reqBuilder.build(); 77 78 // 发送HTTP请求 79 OkHttpClient client = new OkHttpClient.Builder().build(); 80 try (Response httpResponse = client.newCall(httpRequest).execute()) { 81 String respBody = WXPayUtility.extractBody(httpResponse); 82 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 83 // 2XX 成功,验证应答签名 84 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 85 httpResponse.headers(), respBody); 86 87 // 从HTTP应答报文构建返回数据 88 return WXPayUtility.fromJson(respBody, SubsidiesReturnEntity.class); 89 } else { 90 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 91 } 92 } catch (IOException e) { 93 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 94 } 95 } 96 97 private final String mchid; 98 private final String certificateSerialNo; 99 private final PrivateKey privateKey; 100 private final String wechatPayPublicKeyId; 101 private final PublicKey wechatPayPublicKey; 102 103 public ReturnSubsidy(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 104 this.mchid = mchid; 105 this.certificateSerialNo = certificateSerialNo; 106 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 107 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 108 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 109 } 110 111 public static class SubsidiesReturnRequest { 112 @SerializedName("sub_mchid") 113 public String subMchid; 114 115 @SerializedName("out_order_no") 116 public String outOrderNo; 117 118 @SerializedName("transaction_id") 119 public String transactionId; 120 121 @SerializedName("refund_id") 122 public String refundId; 123 124 @SerializedName("amount") 125 public Long amount; 126 127 @SerializedName("description") 128 public String description; 129 130 @SerializedName("subsidy_id") 131 public String subsidyId; 132 133 @SerializedName("from") 134 public List<ReturnFrom> from; 135 } 136 137 public static class SubsidiesReturnEntity { 138 @SerializedName("sub_mchid") 139 public String subMchid; 140 141 @SerializedName("transaction_id") 142 public String transactionId; 143 144 @SerializedName("subsidy_refund_id") 145 public String subsidyRefundId; 146 147 @SerializedName("refund_id") 148 public String refundId; 149 150 @SerializedName("out_order_no") 151 public String outOrderNo; 152 153 @SerializedName("amount") 154 public Long amount; 155 156 @SerializedName("description") 157 public String description; 158 159 @SerializedName("result") 160 public ReturnStatus result; 161 162 @SerializedName("success_time") 163 public String successTime; 164 165 @SerializedName("subsidy_id") 166 public String subsidyId; 167 168 @SerializedName("from") 169 public List<ReturnFrom> from; 170 } 171 172 public static class ReturnFrom { 173 @SerializedName("account") 174 public ReturnAccount account; 175 176 @SerializedName("amount") 177 public Long amount; 178 } 179 180 public enum ReturnStatus { 181 @SerializedName("SUCCESS") 182 SUCCESS, 183 @SerializedName("FAIL") 184 FAIL 185 } 186 187 public enum ReturnAccount { 188 @SerializedName("AVAILABLE") 189 AVAILABLE, 190 @SerializedName("UNAVAILABLE") 191 UNAVAILABLE 192 } 193 194} 195
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &SubsidiesReturnRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 OutOrderNo: wxpay_utility.String("P20150806125346"), 29 TransactionId: wxpay_utility.String("4208450740201411110007820472"), 30 RefundId: wxpay_utility.String("3008450740201411110007820472"), 31 Amount: wxpay_utility.Int64(10), 32 Description: wxpay_utility.String("测试备注"), 33 SubsidyId: wxpay_utility.String("3008450740201411110007820472"), 34 From: []ReturnFrom{ReturnFrom{ 35 Account: RETURNACCOUNT_AVAILABLE.Ptr(), 36 Amount: wxpay_utility.Int64(10), 37 }}, 38 } 39 40 response, err := ReturnSubsidy(config, request) 41 if err != nil { 42 fmt.Printf("请求失败: %+v\n", err) 43 // TODO: 请求失败,根据状态码执行不同的处理 44 return 45 } 46 47 // TODO: 请求成功,继续业务逻辑 48 fmt.Printf("请求成功: %+v\n", response) 49} 50 51func ReturnSubsidy(config *wxpay_utility.MchConfig, request *SubsidiesReturnRequest) (response *SubsidiesReturnEntity, err error) { 52 const ( 53 host = "https://api.mch.weixin.qq.com" 54 method = "POST" 55 path = "/v3/ecommerce/subsidies/return" 56 ) 57 58 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 59 if err != nil { 60 return nil, err 61 } 62 reqBody, err := json.Marshal(request) 63 if err != nil { 64 return nil, err 65 } 66 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 67 if err != nil { 68 return nil, err 69 } 70 httpRequest.Header.Set("Accept", "application/json") 71 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 72 httpRequest.Header.Set("Content-Type", "application/json") 73 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 74 if err != nil { 75 return nil, err 76 } 77 httpRequest.Header.Set("Authorization", authorization) 78 79 client := &http.Client{} 80 httpResponse, err := client.Do(httpRequest) 81 if err != nil { 82 return nil, err 83 } 84 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 85 if err != nil { 86 return nil, err 87 } 88 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 89 // 2XX 成功,验证应答签名 90 err = wxpay_utility.ValidateResponse( 91 config.WechatPayPublicKeyId(), 92 config.WechatPayPublicKey(), 93 &httpResponse.Header, 94 respBody, 95 ) 96 if err != nil { 97 return nil, err 98 } 99 response := &SubsidiesReturnEntity{} 100 if err := json.Unmarshal(respBody, response); err != nil { 101 return nil, err 102 } 103 104 return response, nil 105 } else { 106 return nil, wxpay_utility.NewApiException( 107 httpResponse.StatusCode, 108 httpResponse.Header, 109 respBody, 110 ) 111 } 112} 113 114type SubsidiesReturnRequest struct { 115 SubMchid *string `json:"sub_mchid,omitempty"` 116 OutOrderNo *string `json:"out_order_no,omitempty"` 117 TransactionId *string `json:"transaction_id,omitempty"` 118 RefundId *string `json:"refund_id,omitempty"` 119 Amount *int64 `json:"amount,omitempty"` 120 Description *string `json:"description,omitempty"` 121 SubsidyId *string `json:"subsidy_id,omitempty"` 122 From []ReturnFrom `json:"from,omitempty"` 123} 124 125type SubsidiesReturnEntity struct { 126 SubMchid *string `json:"sub_mchid,omitempty"` 127 TransactionId *string `json:"transaction_id,omitempty"` 128 SubsidyRefundId *string `json:"subsidy_refund_id,omitempty"` 129 RefundId *string `json:"refund_id,omitempty"` 130 OutOrderNo *string `json:"out_order_no,omitempty"` 131 Amount *int64 `json:"amount,omitempty"` 132 Description *string `json:"description,omitempty"` 133 Result *ReturnStatus `json:"result,omitempty"` 134 SuccessTime *string `json:"success_time,omitempty"` 135 SubsidyId *string `json:"subsidy_id,omitempty"` 136 From []ReturnFrom `json:"from,omitempty"` 137} 138 139type ReturnFrom struct { 140 Account *ReturnAccount `json:"account,omitempty"` 141 Amount *int64 `json:"amount,omitempty"` 142} 143 144type ReturnStatus string 145 146func (e ReturnStatus) Ptr() *ReturnStatus { 147 return &e 148} 149 150const ( 151 RETURNSTATUS_SUCCESS ReturnStatus = "SUCCESS" 152 RETURNSTATUS_FAIL ReturnStatus = "FAIL" 153) 154 155type ReturnAccount string 156 157func (e ReturnAccount) Ptr() *ReturnAccount { 158 return &e 159} 160 161const ( 162 RETURNACCOUNT_AVAILABLE ReturnAccount = "AVAILABLE" 163 RETURNACCOUNT_UNAVAILABLE ReturnAccount = "UNAVAILABLE" 164) 165
应答参数
|
sub_mchid 必填 string
【电商平台二级商户号】补差的电商平台二级商户,填写微信支付分配的商户号
transaction_id 必填 string
【微信订单号】微信支付订单号
subsidy_refund_id 必填 string
【微信补差回退单号】微信补差回退单号,微信补差回退系统返回的唯一标识
refund_id 选填 string
【微信退款单号】微信退款单号,微信系统退款返回的唯一标识。因用户账户异常而无法退款时可不传,其他情况必传
out_order_no 必填 string
【商户补差回退单号】商户系统内部的补差回退单号,在商户系统内部唯一,同一补差回退单号多次请求等同一次。只能是数字、大小写字母_-|*@
amount 必填 integer
【补差回退金额】补差回退金额
description 必填 string
【补差回退描述】补差回退描述
result 必填 string
【补差回退结果】补差回退结果
可选取值:
SUCCESS
: 已成功
FAIL
: 已失败
success_time 必填 string
【补差回退完成时间】补差回退完成时间,遵循RFC3339标准格式
subsidy_id 选填 string(64)
【微信补差单号】微信补差单号,微信系统返回的唯一标识
from 选填 array[object]
【回退出资账户及金额】回退出资账户及金额
属性 | |
account 选填 string 【出资账户类型】下面枚举值多选一。 枚举值: AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 可选取值:
amount 选填 integer 【出资金额】对应账户出资金额 |
应答示例
200 OK
1{ 2 "sub_mchid" : "1900000109", 3 "transaction_id" : "4208450740201411110007820472", 4 "subsidy_refund_id" : "3008450740201411110007820472", 5 "refund_id" : "3008450740201411110007820472", 6 "out_order_no" : "P20150806125346", 7 "amount" : 10, 8 "description" : "测试备注", 9 "result" : "SUCCESS", 10 "success_time" : "2015-05-20T13:29:35.120+08:00", 11 "subsidy_id" : "3008450740201411110007820472", 12 "from" : [ 13 { 14 "account" : "AVAILABLE", 15 "amount" : 10 16 } 17 ] 18} 19
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
429 | FREQUENCY_LIMITED | 频率限制 | 请降低频率后重试 |