Merge pull request #2659 from JeffreySu/TenpayV3-Transfer

TenPayV3 v0.6.3 添加“发起商家转账API” #2652 感谢 @y1024866464
JeffreySu · Jun 29, 2022 · c24d4a3 · c24d4a3
2 parents 0562082 + 9f55cb9
commit c24d4a3
Show file tree

Hide file tree

Showing 4 changed files with 262 additions and 1 deletion.
diff --git a/...n.TenPay/Senparc.Weixin.TenPayV3/Apis/Transfer/Entities/RequestData/BatchesRequestData.cs b/...n.TenPay/Senparc.Weixin.TenPayV3/Apis/Transfer/Entities/RequestData/BatchesRequestData.cs
@@ -0,0 +1,117 @@
+#region Apache License Version 2.0
+/*----------------------------------------------------------------
+
+Copyright 2022 Jeffrey Su & Suzhou Senparc Network Technology Co.,Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the specific language governing permissions
+and limitations under the License.
+
+Detail: https://github.com/JeffreySu/WeiXinMPSDK/blob/master/license.md
+
+----------------------------------------------------------------*/
+#endregion Apache License Version 2.0
+
+/*----------------------------------------------------------------
+    Copyright (C) 2022 Senparc
+  
+    文件名：BatchesRequestData.cs
+    文件功能描述：发起商家转账API 请求数据
+    
+    
+    创建标识：Senparc - 20220629
+
+----------------------------------------------------------------*/
+
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Senparc.Weixin.TenPayV3.Apis.Transfer
+{
+    /// <summary>
+    /// 发起商家转账API 请求数据
+    /// </summary>
+    public class BatchesRequestData
+    {
+        /// <summary>
+        /// 直连商户的appid	
+        /// <para>申请商户号的appid或商户号绑定的appid（企业号corpid即为此appid）。示例值：wxf636efh567hg4356</para>
+        /// </summary>
+        public string appid { get; set; }
+        /// <summary>
+        /// 商家批次单号
+        /// <para>商户系统内部的商家批次单号，要求此参数只能由数字、大小写字母组成，在商户系统内部唯一。示例值：plfk2020042013</para>
+        /// </summary>
+        public string out_batch_no { get; set; }
+        /// <summary>
+        /// 批次名称
+        /// <para>商户系统内部的商家批次单号，要求此参数只能由数字、大小写字母组成，在商户系统内部唯一。示例值：plfk2020042013</para>
+        /// </summary>
+        public string batch_name { get; set; }
+        /// <summary>
+        /// 批次备注
+        /// <para>转账说明，UTF8编码，最多允许32个字符。示例值：2019年1月深圳分部报销单</para>
+        /// </summary>
+        public string batch_remark { get; set; }
+        /// <summary>
+        /// 转账总金额
+        /// <para>转账金额单位为“分”。转账总金额必须与批次内所有明细转账金额之和保持一致，否则无法发起转账操作。示例值：4000000</para>
+        /// </summary>
+        public int total_amount { get; set; }
+        /// <summary>
+        /// 转账总笔数
+        /// <para>一个转账批次单最多发起三千笔转账。转账总笔数必须与批次内所有明细之和保持一致，否则无法发起转账操作。示例值：200</para>
+        /// </summary>
+        public int total_num { get; set; }
+        /// <summary>
+        /// 转账明细列表
+        /// <para>发起批量转账的明细列表，最多三千笔</para>
+        /// </summary>
+        public Transfer_Detail_List[] transfer_detail_list { get; set; }
+    }
+
+    public class Transfer_Detail_List
+    {
+        /// <summary>
+        /// 商家明细单号
+        /// <para>商户系统内部区分转账批次单下不同转账明细单的唯一标识，要求此参数只能由数字、大小写字母组成。示例值：x23zy545Bd5436</para>
+        /// </summary>
+        public string out_detail_no { get; set; }
+        /// <summary>
+        /// 转账金额
+        /// <para>转账金额单位为分。示例值：200000</para>
+        /// </summary>
+        public int transfer_amount { get; set; }
+        /// <summary>
+        /// 转账备注
+        /// <para>单条转账备注（微信用户会收到该备注），UTF8编码，最多允许32个字符。示例值：2020年4月报销</para>
+        /// </summary>
+        public string transfer_remark { get; set; }
+        /// <summary>
+        /// 用户在直连商户应用下的用户标示	
+        /// <para>openid是微信用户在公众号appid下的唯一用户标识（appid不同，则获取到的openid就不同），可用于永久标记一个用户。</para>
+        /// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml">获取openid</see></para>
+        /// <para>示例值：o-MYE42l80oelYMDE34nYD456Xoy</para>
+        /// </summary>
+        public string openid { get; set; }
+        /// <summary>
+        /// 收款用户姓名
+        /// <para>1、明细转账金额 >= 2,000，收款用户姓名必填；</para>
+        /// <para>2、同一批次转账明细中，收款用户姓名字段需全部填写、或全部不填写；</para>
+        /// <para>3、 若传入收款用户姓名，微信支付会校验用户openID与姓名是否一致，并提供电子回单；</para>
+        /// <para>4、收款方姓名。采用标准RSA算法，公钥由微信侧提供</para>
+        /// <para>5、该字段需进行加密处理，加密方法详见敏感信息加密说明。(提醒：必须在HTTP头中上送Wechatpay-Serial)</para>
+        /// <para>6、商户需确保收集用户的姓名信息，以及向微信支付传输用户姓名和账号标识信息做一致性校验已合法征得用户授权</para>
+        /// <para>示例值：757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45</para>
+        /// </summary>
+        public string user_name { get; set; }
+    }
+
+}
diff --git a/...xin.TenPay/Senparc.Weixin.TenPayV3/Apis/Transfer/Entities/ReturnJson/BatchesReturnJson.cs b/...xin.TenPay/Senparc.Weixin.TenPayV3/Apis/Transfer/Entities/ReturnJson/BatchesReturnJson.cs
@@ -0,0 +1,62 @@
+#region Apache License Version 2.0
+/*----------------------------------------------------------------
+
+Copyright 2022 Jeffrey Su & Suzhou Senparc Network Technology Co.,Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the specific language governing permissions
+and limitations under the License.
+
+Detail: https://github.com/JeffreySu/WeiXinMPSDK/blob/master/license.md
+
+----------------------------------------------------------------*/
+#endregion Apache License Version 2.0
+
+/*----------------------------------------------------------------
+    Copyright (C) 2022 Senparc
+  
+    文件名：BatchesReturnJson.cs
+    文件功能描述：发起商家转账API 返回信息
+    
+    
+    创建标识：Senparc - 20220629
+
+----------------------------------------------------------------*/
+
+using Senparc.Weixin.TenPayV3.Apis.Entities;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Senparc.Weixin.TenPayV3.Apis.Transfer
+{
+    /// <summary>
+    /// 发起商家转账API 返回信息
+    /// </summary>
+    public class BatchesReturnJson : ReturnJsonBase
+    {
+        /// <summary>
+        /// 商家批次单号
+        /// <para>商户系统内部的商家批次单号。示例值：plfk2020042013</para>
+        /// </summary>
+        public string out_batch_no { get; set; }
+        /// <summary>
+        /// 微信批次单号
+        /// <para>微信批次单号，微信商家转账系统返回的唯一标识。示例值：1030000071100999991182020050700019480001</para>
+        /// </summary>
+        public string batch_id { get; set; }
+        /// <summary>
+        /// 批次创建时间
+        /// <para>批次受理成功时返回，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒</para>
+        /// <para>示例值：2015-05-20T13:29:35.120+08:00</para>
+        /// </summary>
+        public DateTime create_time { get; set; }
+    }
+
+}
diff --git a/src/Senparc.Weixin.TenPay/Senparc.Weixin.TenPayV3/Apis/Transfer/TransferApis.cs b/src/Senparc.Weixin.TenPay/Senparc.Weixin.TenPayV3/Apis/Transfer/TransferApis.cs
@@ -0,0 +1,81 @@
+#region Apache License Version 2.0
+/*----------------------------------------------------------------
+
+Copyright 2022 Jeffrey Su & Suzhou Senparc Network Technology Co.,Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the specific language governing permissions
+and limitations under the License.
+
+Detail: https://github.com/JeffreySu/WeiXinMPSDK/blob/master/license.md
+
+----------------------------------------------------------------*/
+#endregion Apache License Version 2.0
+
+/*----------------------------------------------------------------
+    Copyright (C) 2022 Senparc
+  
+    文件名：TransferApis.cs
+    文件功能描述：微信支付 V3 资金应用 - 发起商家转账 API
+    
+    
+    创建标识：Senparc - 20220629
+
+----------------------------------------------------------------*/
+
+using Senparc.Weixin.Entities;
+using System.Threading.Tasks;
+
+namespace Senparc.Weixin.TenPayV3.Apis.Transfer
+{
+    /// <summary>
+    /// 微信支付 V3 资金应用 - 发起商家转账 API
+    /// https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter4_3_1.shtml 下的【发起商家转账 API】所有接口
+    /// </summary>
+    public partial class TransferApis
+    {
+        private ISenparcWeixinSettingForTenpayV3 _tenpayV3Setting;
+
+        /// <summary>
+        /// 构造函数
+        /// </summary>
+        /// <param name="senparcWeixinSettingForTenpayV3"></param>
+        public TransferApis(ISenparcWeixinSettingForTenpayV3 senparcWeixinSettingForTenpayV3 = null)
+        {
+
+            _tenpayV3Setting = senparcWeixinSettingForTenpayV3 ?? Senparc.Weixin.Config.SenparcWeixinSetting.TenpayV3Setting;
+        }
+
+
+        /// <summary>
+        /// 返回可用的微信支付地址（自动判断是否使用沙箱）
+        /// </summary>
+        /// <param name="urlFormat">如：<code>https://api.mch.weixin.qq.com/{0}pay/unifiedorder</code></param>
+        /// <returns></returns>
+        // TODO: 重复使用
+        private static string ReurnPayApiUrl(string urlFormat)
+        {
+            return string.Format(urlFormat, Senparc.Weixin.Config.UseSandBoxPay ? "sandboxnew/" : "");
+        }
+
+        /// <summary>
+        /// 发起商家转账API
+        /// <para>https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter4_3_1.shtml</para>
+        /// </summary>
+        /// <param name="data"></param>
+        /// <param name="timeOut"></param>
+        /// <returns></returns>
+        public async Task<BatchesReturnJson> BatchesAsync(BatchesRequestData data, int timeOut = Config.TIME_OUT)
+        {
+            var url = ReurnPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/transfer/batches");
+            TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
+            return await tenPayApiRequest.RequestAsync<BatchesReturnJson>(url, data, timeOut);
+        }
+    }
+}
diff --git a/src/Senparc.Weixin.TenPay/Senparc.Weixin.TenPayV3/Senparc.Weixin.TenPayV3.net6.csproj b/src/Senparc.Weixin.TenPay/Senparc.Weixin.TenPayV3/Senparc.Weixin.TenPayV3.net6.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-    <Version>0.6.2.3-beta1</Version>
+    <Version>0.6.3-beta1</Version>
     <AssemblyName>Senparc.Weixin.TenPayV3</AssemblyName>
     <RootNamespace>Senparc.Weixin.TenPayV3</RootNamespace>
     <LangVersion>10.0</LangVersion>
@@ -32,6 +32,7 @@
 		v0.5.7 升级微信支付请求的方法，支持多种加密方式
 		v0.6.1 修复 CloseOrderAsync() 参数问题
 		v0.6.2.2 修复 TenPayHttpClient 赋值问题
+		v0.6.3 添加“发起商家转账API”
 	</PackageReleaseNotes>
     <RepositoryUrl>https://github.com/JeffreySu/WeiXinMPSDK</RepositoryUrl>
   </PropertyGroup>