You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

408 lines
25 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

#region Apache License Version 2.0
/*----------------------------------------------------------------
Copyright 2023 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) 2023 Senparc
文件名MarketingApis.Favor.cs
文件功能描述微信支付V3营销工具接口
创建标识Senparc - 20210821
----------------------------------------------------------------*/
using Senparc.CO2NET.Helpers;
using Senparc.CO2NET.Trace;
using Senparc.Weixin.TenPayV3.Apis.Entities;
using Senparc.Weixin.TenPayV3.Apis.Marketing;
using Senparc.Weixin.TenPayV3.Entities;
using System;
using System.IO;
using System.Threading.Tasks;
namespace Senparc.Weixin.TenPayV3.Apis
{
/// <summary>
/// 微信支付V3营销工具接口
/// https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_1.shtml 下的【营销工具】所有接口 &gt; 【代金券接口】
/// </summary>
public partial class MarketingApis
{
#region 代金券接口
/// <summary>
/// 创建代金券批次接口
/// <para>调用此接口创建微信支付代金券批次创建完成后将获得代金券批次id。</para>
/// <para>更多详细请参考 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_1.shtml </para>
/// <para>提示:使用此功能必须在后台【产品中心】开通【预充值代金券】功能!</para>
/// </summary>
/// <param name="data">微信支付需要POST的Data数据</param>
/// <param name="timeOut">超时时间单位为ms </param>
/// <returns></returns>
public async Task<CreateStockReturnJson> CreateStockAsync(CreateStockRequsetData data, int timeOut = Config.TIME_OUT)
{
const string STOCK_TYPE = "NORMAL";
if (data.stock_type == STOCK_TYPE && data.coupon_use_rule.fixed_normal_coupon == null)
{
throw new TenpayApiRequestException($"当 {nameof(data.stock_type)} 为 {STOCK_TYPE} 时,{nameof(data.coupon_use_rule.fixed_normal_coupon)} 必填!");
}
if (data.stock_use_rule.max_amount != data.stock_use_rule.max_coupons * data.coupon_use_rule.fixed_normal_coupon.coupon_amount)
{
throw new TenpayApiRequestException($"{nameof(data.stock_use_rule.max_amount)} 必须等于 {nameof(data.stock_use_rule.max_coupons)} 乘以 {nameof(data.coupon_use_rule.fixed_normal_coupon.coupon_amount)}");
}
if (data.coupon_use_rule.fixed_normal_coupon.coupon_amount > data.coupon_use_rule.fixed_normal_coupon.transaction_minimum)
{
throw new TenpayApiRequestException($"{nameof(data.coupon_use_rule.fixed_normal_coupon.coupon_amount)} 必须小于等于 {nameof(data.coupon_use_rule.fixed_normal_coupon.transaction_minimum)}");
}
var url = BasePayApis.GetPayApiUrl(Senparc.Weixin.Config.TenPayV3Host + "/{0}v3/marketing/favor/coupon-stocks");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<CreateStockReturnJson>(url, data, timeOut);
}
/// <summary>
/// 激活代金券批次接口
/// <para>制券成功后,通过调用此接口激活批次,如果是预充值代金券,激活时会从商户账户余额中锁定本批次的营销资金</para>
/// <para>更多详细请参考 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_3.shtml </para>
/// </summary>
/// <param name="stock_id">批次号 微信为每个代金券批次分配的唯一id</param>
/// <param name="data">微信支付需要POST的Data数据</param>
/// <param name="timeOut">超时时间单位为ms </param>
/// <returns></returns>
public async Task<StartStockReturnJson> StartStockAsync(string stock_id, StartStockRequsetData data, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/start");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<StartStockReturnJson>(url, data, timeOut);
}
/// <summary>
/// 发放代金券批次接口
/// <para>商户平台/API完成制券后可使用发放代金券接口发券。通过调用此接口可发放指定批次给指定用户发券场景可以是小程序、H5、APP等</para>
/// <para>更多详细请参考 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_2.shtml </para>
/// </summary>
/// <param name="openid">用户openid</param>
/// <param name="data">微信支付需要POST的Data数据</param>
/// <param name="timeOut">超时时间单位为ms </param>
/// <returns></returns>
public async Task<DistributeStockReturnJson> DistributeStockAsync(string openid, DistributeStockRequsetData data, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/users/{openid}/coupons");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<DistributeStockReturnJson>(url, data, timeOut);
}
/// <summary>
/// 暂停发放代金券批次接口
/// <para>通过此接口可暂停指定代金券批次。暂停后,该代金券批次暂停发放,用户无法通过任何渠道再领取该批次的券</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_13.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="stock_id">批次号 微信为每个代金券批次分配的唯一id 校验规则:必须为代金券(全场券或单品券)批次号,不支持立减与折扣。</param>
/// <param name="stock_creator_mchid">批次创建方商户号 校验规则接口传入的批次号需由stock_creator_mchid所创建</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<PauseStockReturnJson> PauseStockAsync(string stock_id, string stock_creator_mchid, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/pause");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<PauseStockReturnJson>(url, new { stock_creator_mchid = stock_creator_mchid }, timeOut);
}
/// <summary>
/// 重启发放代金券批次接口
/// <para>通过此接口可重启指定代金券批次。重启后,该代金券批次可以再次发放</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_14.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="stock_id">批次号 微信为每个代金券批次分配的唯一id 校验规则:必须为代金券(全场券或单品券)批次号,不支持立减与折扣。</param>
/// <param name="stock_creator_mchid">批次创建方商户号 校验规则接口传入的批次号需由stock_creator_mchid所创建</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<RestartStockReturnJson> RestartStockAsync(string stock_id, string stock_creator_mchid, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/restart");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<RestartStockReturnJson>(url, new { stock_creator_mchid = stock_creator_mchid }, timeOut);
}
/// <summary>
/// 条件查询代金券批次列表
/// <para>通过此接口可查询多个批次的信息,包括批次的配置信息以及批次概况数据</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_4.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="offset">分页页码 页码从0开始默认第0页</param>
/// <param name="limit">分页大小最大10</param>
/// <param name="stock_creator_mchid">批次创建方商户号 校验规则接口传入的批次号需由stock_creator_mchid所创建</param>
/// <param name="create_start_time">起始创建时间遵循rfc3339标准格式格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE可为null</param>
/// <param name="create_end_time">终止创建时间遵循rfc3339标准格式格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE可为null</param>
/// <param name="status">批次状态,枚举值: unactivated未激活 audit审核中 running运行中 stoped已停止 paused暂停发放可为null
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<QueryStocksReturnJson> QueryStocksAsync(uint offset, uint limit, string stock_creator_mchid, TenpayDateTime create_start_time = null, TenpayDateTime create_end_time = null, string status = null, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks?offset={offset}&limit={limit}&stock_creator_mchid={stock_creator_mchid}");
if (create_start_time is not null)
{
url += $"&create_start_time={create_start_time}";
}
if (create_end_time is not null)
{
url += $"&create_end_time={create_end_time}";
}
if (status is not null)
{
url += $"&status={status}";
}
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<QueryStocksReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
}
/// <summary>
/// 查询批次详情
/// <para>通过此接口可查询批次信息,包括批次的配置信息以及批次概况数据</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_5.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="stock_id">批次号 微信为每个代金券批次分配的唯一id 校验规则:必须为代金券(全场券或单品券)批次号,不支持立减与折扣。</param>
/// <param name="stock_creator_mchid">批次创建方商户号 校验规则接口传入的批次号需由stock_creator_mchid所创建</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<StockReturnJson> QueryStockAsync(string stock_id, string stock_creator_mchid, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}?stock_creator_mchid={stock_creator_mchid}");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<StockReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
}
/// <summary>
/// 查询代金券可用商户
/// <para>通过调用此接口可查询批次的可用商户号,判断券是否在某商户号可用,来决定是否展示</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_7.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="offset">分页页码</param>
/// <param name="limit">分页大小</param>
/// <param name="stock_creator_mchid">创建批次的商户号</param>
/// <param name="stock_id">批次号</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<QueryMerchantsReturnJson> QueryMerchantsStockAsync(uint offset, uint limit, string stock_creator_mchid, string stock_id, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/merchants?offset={offset}&limit={limit}&stock_creator_mchid={stock_creator_mchid}");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<QueryMerchantsReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
}
/// <summary>
/// 查询代金券可用单品
/// <para>通过此接口可查询批次的可用商品编码,判断券是否可用于某些商品,来决定是否展示</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_8.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="offset">分页页码</param>
/// <param name="limit">分页大小</param>
/// <param name="stock_creator_mchid">创建批次的商户号</param>
/// <param name="stock_id">批次号</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<QueryItemsReturnJson> QueryItemsAsync(uint offset, uint limit, string stock_creator_mchid, string stock_id, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/items?offset={offset}&limit={limit}&stock_creator_mchid={stock_creator_mchid}");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<QueryItemsReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
}
/// <summary>
/// 根据商户号查用户的券
/// <para>可通过该接口查询用户在某商户号可用的全部券,可用于商户的小程序/H5中用户"我的代金券"或"提交订单页"展示优惠信息。无法查询到微信支付立减金。本接口查不到用户的微信支付立减金(又称“全平台通用券”),即在所有商户都可以使用的券,例如:摇摇乐红包;当按可用商户号查询时,无法查询用户已经核销的券</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_9.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="openid">用户在商户appid下的唯一标识</param>
/// <param name="appid">微信为发券方商户分配的公众账号ID</param>
/// <param name="stock_id">批次号是否指定批次号查询填写available_mchid该字段不生效可为null</param>
/// <param name="status">代金券状态:枚举值: SENDED可用 USED已实扣 填写available_mchid该字段不生效可为null</param>
/// <param name="creator_mchid">批次创建方商户号creator_mchid sender_mchid available_mchid三选一</param>
/// <param name="sender_mchid">批次发放商户号该字段暂未开放creator_mchid sender_mchid available_mchid三选一</param>
/// <param name="available_mchid">可用商户号creator_mchid sender_mchid available_mchid三选一</param>
/// <param name="offset">分页页码</param>
/// <param name="limit">分页大小</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<QueryCouponsReturnJson> QueryCouponsAsync(string openid, string appid, string stock_id, string status, string creator_mchid, string sender_mchid, string available_mchid, uint offset = 0, uint limit = 20, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/users/{openid}/coupons?appid={appid}&offset={offset}&limit={limit}");
if (stock_id is not null)
{
url += $"&stock_id={stock_id}";
}
if (status is not null)
{
url += $"&status={status}";
}
if (creator_mchid is not null)
{
url += $"&creator_mchid={creator_mchid}";
}
if (sender_mchid is not null)
{
url += $"&sender_mchid={sender_mchid}";
}
if (available_mchid is not null)
{
url += $"&available_mchid={available_mchid}";
}
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<QueryCouponsReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
}
/// <summary>
/// 查询代金券详情
/// <para>通过此接口可查询代金券信息,包括代金券的基础信息、状态。如代金券已核销,会包括代金券核销的订单信息(订单号、单品信息等)</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_6.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="coupon_id">微信为代金券唯一分配的id</param>
/// <param name="appid">公众账号ID</param>
/// <param name="openid">openid信息用户在appid下的唯一标识</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<QueryCouponReturnJson> QueryCouponAsync(string coupon_id, string appid, string openid, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/users/{openid}/coupons/{coupon_id}?appid={appid}");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<QueryCouponReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
}
/// <summary>
/// 下载批次核销明细
/// 可获取到某批次的核销明细数据,包括订单号、单品信息、银行流水号等,用于对账/数据分析
/// <para>https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_10.shtml</para>
/// </summary>
/// <param name="stock_id">批次号</param>
/// <param name="fileStream">fileStream</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<DownloadStockUseFlowReturnJson> DownloadStockUseFlowAsync(string stock_id, Stream fileStream, int timeOut = Config.TIME_OUT)
{
try
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/use-flow");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
var result = await tenPayApiRequest.RequestAsync<DownloadStockUseFlowReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
//下载交易账单
if (result.VerifySignSuccess == true)
{
var responseMessage = await tenPayApiRequest.GetHttpResponseMessageAsync(result.url, null, requestMethod: ApiRequestMethod.GET);
fileStream.Seek(0, SeekOrigin.Begin);
await responseMessage.Content.CopyToAsync(fileStream);
fileStream.Seek(0, SeekOrigin.Begin);
//校验文件Hash
var fileHash = FileHelper.GetFileHash(fileStream, result.hash_type, false);
Console.WriteLine("fileHash: " + fileHash);
var fileVerify = fileHash.Equals(result.hash_value, StringComparison.OrdinalIgnoreCase);
if (!fileVerify)
{
result.VerifySignSuccess = false;
result.ResultCode.Additional += "请求成功,但文件校验错误。请查看日志!";
SenparcTrace.BaseExceptionLog(new TenpayApiRequestException($"TradeBillQueryAsync 下载文件成功,但校验失败,正确值:{result.hash_value},实际值:{fileHash}(忽略大小写)"));
}
}
return result;
}
catch (Exception ex)
{
SenparcTrace.BaseExceptionLog(ex);
return new DownloadStockUseFlowReturnJson() { ResultCode = new TenPayApiResultCode() { ErrorMessage = ex.Message } };
}
}
/// <summary>
/// 下载批次退款明细
/// 可获取到某批次的退款明细数据,包括订单号、单品信息、银行流水号等,用于对账/数据分析
/// <para>https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_11.shtml</para>
/// </summary>
/// <param name="stock_id">批次号</param>
/// <param name="fileStream">fileStream</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<DownloadStockRefundFlowReturnJson> DownloadStockRefundFlowAsync(string stock_id, Stream fileStream, int timeOut = Config.TIME_OUT)
{
try
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/stocks/{stock_id}/refund-flow");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
var result = await tenPayApiRequest.RequestAsync<DownloadStockRefundFlowReturnJson>(url, null, timeOut, ApiRequestMethod.GET);
//下载交易账单
if (result.VerifySignSuccess == true)
{
var responseMessage = await tenPayApiRequest.GetHttpResponseMessageAsync(result.url, null, requestMethod: ApiRequestMethod.GET);
fileStream.Seek(0, SeekOrigin.Begin);
await responseMessage.Content.CopyToAsync(fileStream);
fileStream.Seek(0, SeekOrigin.Begin);
//校验文件Hash
var fileHash = FileHelper.GetFileHash(fileStream, result.hash_type, false);
Console.WriteLine("fileHash: " + fileHash);
var fileVerify = fileHash.Equals(result.hash_value, StringComparison.OrdinalIgnoreCase);
if (!fileVerify)
{
result.VerifySignSuccess = false;
result.ResultCode.Additional += "请求成功,但文件校验错误。请查看日志!";
SenparcTrace.BaseExceptionLog(new TenpayApiRequestException($"TradeBillQueryAsync 下载文件成功,但校验失败,正确值:{result.hash_value},实际值:{fileHash}(忽略大小写)"));
}
}
return result;
}
catch (Exception ex)
{
SenparcTrace.BaseExceptionLog(ex);
return new DownloadStockRefundFlowReturnJson() { ResultCode = new TenPayApiResultCode() { ErrorMessage = ex.Message } };
}
}
/// <summary>
/// 设置消息通知地址
/// <para>于设置接收营销事件通知的URL可接收营销相关的事件通知包括核销、发放、退款等</para>
/// <para><see href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_12.shtml">更多详细请参考微信支付官方文档</see></para>
/// </summary>
/// <param name="data">微信支付需要POST的Data数据</param>
/// <param name="timeOut">超时时间单位为ms</param>
/// <returns></returns>
public async Task<SetNotifyUrlReturnJson> SetNotifyUrlAsync(SetNotifyUrlRequsetData data, int timeOut = Config.TIME_OUT)
{
var url = BasePayApis.GetPayApiUrl($"{Senparc.Weixin.Config.TenPayV3Host}/{{0}}v3/marketing/favor/callbacks");
TenPayApiRequest tenPayApiRequest = new(_tenpayV3Setting);
return await tenPayApiRequest.RequestAsync<SetNotifyUrlReturnJson>(url, data, timeOut);
}
#endregion
}
}