feat(tenpayv3): 新增银行组件相关接口

This commit is contained in:
Fu Diwei 2022-01-07 13:28:11 +08:00
parent 36c0a6e570
commit 2f300f45f9
23 changed files with 609 additions and 0 deletions

View File

@ -0,0 +1,141 @@
using System;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Flurl;
using Flurl.Http;
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3
{
/// <summary>
/// 为 <see cref="WechatTenpayClient"/> 提供银行组件相关的 API 扩展方法。
/// </summary>
public static class WechatTenpayClientExecuteCapitalExtensions
{
#region Banks
/// <summary>
/// <para>异步调用 [GET] /capital/capitallhh/banks/search-banks-by-bank-account 接口。</para>
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3/Offline/apis/chapter11_2_1.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.QueryCapitalBanksByBankAccountResponse> ExecuteQueryCapitalBanksByBankAccountAsync(this WechatTenpayClient client, Models.QueryCapitalBanksByBankAccountRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Get, "capital", "capitallhh", "banks", "search-banks-by-bank-account")
.SetQueryParam("account_number", request.AccountNumber);
return await client.SendRequestWithJsonAsync<Models.QueryCapitalBanksByBankAccountResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [GET] /capital/capitallhh/banks/personal-banking 接口。</para>
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3/Offline/apis/chapter11_2_2.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.QueryCapitalBanksPersonalBankingResponse> ExecuteQueryCapitalBanksPersonalBankingAsync(this WechatTenpayClient client, Models.QueryCapitalBanksPersonalBankingRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Get, "capital", "capitallhh", "banks", "personal-banking")
.SetQueryParam("limit", request.Limit)
.SetQueryParam("offset", request.Offset);
return await client.SendRequestWithJsonAsync<Models.QueryCapitalBanksPersonalBankingResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [GET] /capital/capitallhh/banks/corporate-banking 接口。</para>
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3/Offline/apis/chapter11_2_3.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.QueryCapitalBanksCorporateBankingResponse> ExecuteQueryCapitalBanksCorporateBankingAsync(this WechatTenpayClient client, Models.QueryCapitalBanksCorporateBankingRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Get, "capital", "capitallhh", "banks", "corporate-banking")
.SetQueryParam("limit", request.Limit)
.SetQueryParam("offset", request.Offset);
return await client.SendRequestWithJsonAsync<Models.QueryCapitalBanksCorporateBankingResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [GET] /capital/capitallhh/banks/{bank_alias_code}/branches 接口。</para>
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3/Offline/apis/chapter11_2_6.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.QueryCapitalBanksBranchesResponse> ExecuteQueryCapitalBanksBranchesAsync(this WechatTenpayClient client, Models.QueryCapitalBanksBranchesRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Get, "capital", "capitallhh", "banks", request.BankAliasCode, "branches")
.SetQueryParam("city_code", request.CityCode)
.SetQueryParam("limit", request.Limit)
.SetQueryParam("offset", request.Offset);
return await client.SendRequestWithJsonAsync<Models.QueryCapitalBanksBranchesResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
#endregion
#region Areas
/// <summary>
/// <para>异步调用 [GET] /capital/capitallhh/areas/provinces 接口。</para>
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3/Offline/apis/chapter11_2_4.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.QueryCapitalAreasProvincesResponse> ExecuteQueryCapitalAreasProvincesAsync(this WechatTenpayClient client, Models.QueryCapitalAreasProvincesRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Get, "capital", "capitallhh", "areas", "provinces");
return await client.SendRequestWithJsonAsync<Models.QueryCapitalAreasProvincesResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [GET] /capital/capitallhh/areas/provinces/{province_code}/cities 接口。</para>
/// <para>REF: https://pay.weixin.qq.com/wiki/doc/apiv3/Offline/apis/chapter11_2_5.shtml </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.QueryCapitalAreasCitiesResponse> ExecuteQueryCapitalAreasCitiesAsync(this WechatTenpayClient client, Models.QueryCapitalAreasCitiesRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Get, "capital", "capitallhh", "areas", "provinces", request.ProvinceCode, "cities");
return await client.SendRequestWithJsonAsync<Models.QueryCapitalAreasCitiesResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
#endregion
}
}

View File

@ -0,0 +1,15 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/areas/provinces/{province_code}/cities 接口的请求。</para>
/// </summary>
public class QueryCapitalAreasCitiesRequest : WechatTenpayRequest
{
/// <summary>
/// 获取或设置省份编码。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int ProvinceCode { get; set; }
}
}

View File

@ -0,0 +1,42 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/areas/provinces/{province_code}/cities 接口的响应。</para>
/// </summary>
public class QueryCapitalAreasCitiesResponse : WechatTenpayResponse
{
public static class Types
{
public class City
{
/// <summary>
/// 获取或设置城市名称。
/// </summary>
[Newtonsoft.Json.JsonProperty("city_name")]
[System.Text.Json.Serialization.JsonPropertyName("city_name")]
public string CityName { get; set; } = default!;
/// <summary>
/// 获取或设置城市编码。
/// </summary>
[Newtonsoft.Json.JsonProperty("city_code")]
[System.Text.Json.Serialization.JsonPropertyName("city_code")]
public int CityCode { get; set; }
}
}
/// <summary>
/// 获取或设置城市列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public Types.City[] CityList { get; set; } = default!;
/// <summary>
/// 获取或设置数据总条数。
/// </summary>
[Newtonsoft.Json.JsonProperty("total_count")]
[System.Text.Json.Serialization.JsonPropertyName("total_count")]
public int TotalCount { get; set; }
}
}

View File

@ -0,0 +1,9 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/areas/provinces 接口的请求。</para>
/// </summary>
public class QueryCapitalAreasProvincesRequest : WechatTenpayRequest
{
}
}

View File

@ -0,0 +1,42 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/areas/provinces 接口的响应。</para>
/// </summary>
public class QueryCapitalAreasProvincesResponse : WechatTenpayResponse
{
public static class Types
{
public class Province
{
/// <summary>
/// 获取或设置省份名称。
/// </summary>
[Newtonsoft.Json.JsonProperty("province_name")]
[System.Text.Json.Serialization.JsonPropertyName("province_name")]
public string ProvinceName { get; set; } = default!;
/// <summary>
/// 获取或设置省份编码。
/// </summary>
[Newtonsoft.Json.JsonProperty("province_code")]
[System.Text.Json.Serialization.JsonPropertyName("province_code")]
public int ProvinceCode { get; set; }
}
}
/// <summary>
/// 获取或设置省份列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public Types.Province[] ProvinceList { get; set; } = default!;
/// <summary>
/// 获取或设置数据总条数。
/// </summary>
[Newtonsoft.Json.JsonProperty("total_count")]
[System.Text.Json.Serialization.JsonPropertyName("total_count")]
public int TotalCount { get; set; }
}
}

View File

@ -0,0 +1,36 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/{bank_alias_code}/branches 接口的请求。</para>
/// </summary>
public class QueryCapitalBanksBranchesRequest : WechatTenpayRequest
{
/// <summary>
/// 获取或设置银行别名编码。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public string BankAliasCode { get; set; } = string.Empty;
/// <summary>
/// 获取或设置城市编码。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int CityCode { get; set; }
/// <summary>
/// 获取或设置分页大小。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int Limit { get; set; } = 10;
/// <summary>
/// 获取或设置分页开始位置。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int Offset { get; set; }
}
}

View File

@ -0,0 +1,77 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/{bank_alias_code}/branches 接口的响应。</para>
/// </summary>
public class QueryCapitalBanksBranchesResponse : WechatTenpayResponse
{
public static class Types
{
public class Branch
{
/// <summary>
/// 获取或设置支行名称。
/// </summary>
[Newtonsoft.Json.JsonProperty("bank_branch_name")]
[System.Text.Json.Serialization.JsonPropertyName("bank_branch_name")]
public string BranchName { get; set; } = default!;
/// <summary>
/// 获取或设置支行联行号。
/// </summary>
[Newtonsoft.Json.JsonProperty("bank_branch_id")]
[System.Text.Json.Serialization.JsonPropertyName("bank_branch_id")]
public string BranchId { get; set; } = default!;
}
}
/// <summary>
/// 获取或设置支行列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public Types.Branch[] BranchList { get; set; } = default!;
/// <summary>
/// 获取或设置分页开始位置。
/// </summary>
[Newtonsoft.Json.JsonProperty("offset")]
[System.Text.Json.Serialization.JsonPropertyName("offset")]
public int Offset { get; set; }
/// <summary>
/// 获取或设置数据总条数。
/// </summary>
[Newtonsoft.Json.JsonProperty("total_count")]
[System.Text.Json.Serialization.JsonPropertyName("total_count")]
public int TotalCount { get; set; }
/// <summary>
/// 获取或设置银行别名。
/// </summary>
[Newtonsoft.Json.JsonProperty("bank_alias")]
[System.Text.Json.Serialization.JsonPropertyName("bank_alias")]
public string BankAlias { get; set; } = default!;
/// <summary>
/// 获取或设置银行别名编码。
/// </summary>
[Newtonsoft.Json.JsonProperty("bank_alias_code")]
[System.Text.Json.Serialization.JsonPropertyName("bank_alias_code")]
public string BankAliasCode { get; set; } = default!;
/// <summary>
/// 获取或设置开户银行。
/// </summary>
[Newtonsoft.Json.JsonProperty("account_bank")]
[System.Text.Json.Serialization.JsonPropertyName("account_bank")]
public string AccountBank { get; set; } = default!;
/// <summary>
/// 获取或设置开户银行编码。
/// </summary>
[Newtonsoft.Json.JsonProperty("account_bank_code")]
[System.Text.Json.Serialization.JsonPropertyName("account_bank_code")]
public int AccountBankCode { get; set; }
}
}

View File

@ -0,0 +1,17 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/search-banks-by-bank-account 接口的请求。</para>
/// </summary>
[WechatTenpaySensitive]
public class QueryCapitalBanksByBankAccountRequest : WechatTenpayRequest
{
/// <summary>
/// 获取或设置银行卡号(需使用平台公钥/证书加密)。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
[WechatTenpaySensitiveProperty(algorithm: Constants.EncryptionAlgorithms.RSA_2048_PKCS8_ECB)]
public string AccountNumber { get; set; } = string.Empty;
}
}

View File

@ -0,0 +1,65 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/search-banks-by-bank-account 接口的响应。</para>
/// </summary>
public class QueryCapitalBanksByBankAccountResponse : WechatTenpayResponse
{
public static class Types
{
public class Bank
{
/// <summary>
/// 获取或设置银行别名。
/// </summary>
[Newtonsoft.Json.JsonProperty("bank_alias")]
[System.Text.Json.Serialization.JsonPropertyName("bank_alias")]
public string BankAlias { get; set; } = default!;
/// <summary>
/// 获取或设置银行别名编码。
/// </summary>
[Newtonsoft.Json.JsonProperty("bank_alias_code")]
[System.Text.Json.Serialization.JsonPropertyName("bank_alias_code")]
public string BankAliasCode { get; set; } = default!;
/// <summary>
/// 获取或设置开户银行。
/// </summary>
[Newtonsoft.Json.JsonProperty("account_bank")]
[System.Text.Json.Serialization.JsonPropertyName("account_bank")]
public string AccountBank { get; set; } = default!;
/// <summary>
/// 获取或设置开户银行编码。
/// </summary>
[Newtonsoft.Json.JsonProperty("account_bank_code")]
[System.Text.Json.Serialization.JsonPropertyName("account_bank_code")]
public int AccountBankCode { get; set; }
/// <summary>
/// 获取或设置是否需要填写支行。
/// </summary>
[Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.TextualBooleanConverter))]
[Newtonsoft.Json.JsonProperty("need_bank_branch")]
[System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Converters.TextualBooleanConverter))]
[System.Text.Json.Serialization.JsonPropertyName("need_bank_branch")]
public bool RequireBankBranch { get; set; }
}
}
/// <summary>
/// 获取或设置银行列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public Types.Bank[] BankList { get; set; } = default!;
/// <summary>
/// 获取或设置数据总条数。
/// </summary>
[Newtonsoft.Json.JsonProperty("total_count")]
[System.Text.Json.Serialization.JsonPropertyName("total_count")]
public int TotalCount { get; set; }
}
}

View File

@ -0,0 +1,9 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/corporate-banking 接口的请求。</para>
/// </summary>
public class QueryCapitalBanksCorporateBankingRequest : QueryCapitalBanksPersonalBankingRequest
{
}
}

View File

@ -0,0 +1,36 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/corporate-banking 接口的响应。</para>
/// </summary>
public class QueryCapitalBanksCorporateBankingResponse : WechatTenpayResponse
{
public static class Types
{
public class Bank : QueryCapitalBanksPersonalBankingResponse.Types.Bank
{
}
}
/// <summary>
/// 获取或设置银行列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public Types.Bank[] BankList { get; set; } = default!;
/// <summary>
/// 获取或设置分页开始位置。
/// </summary>
[Newtonsoft.Json.JsonProperty("offset")]
[System.Text.Json.Serialization.JsonPropertyName("offset")]
public int Offset { get; set; }
/// <summary>
/// 获取或设置数据总条数。
/// </summary>
[Newtonsoft.Json.JsonProperty("total_count")]
[System.Text.Json.Serialization.JsonPropertyName("total_count")]
public int TotalCount { get; set; }
}
}

View File

@ -0,0 +1,22 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/personal-banking 接口的请求。</para>
/// </summary>
public class QueryCapitalBanksPersonalBankingRequest : WechatTenpayRequest
{
/// <summary>
/// 获取或设置分页大小。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int Limit { get; set; } = 10;
/// <summary>
/// 获取或设置分页开始位置。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int Offset { get; set; }
}
}

View File

@ -0,0 +1,36 @@
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>
/// <para>表示 [GET] /capital/capitallhh/banks/personal-banking 接口的响应。</para>
/// </summary>
public class QueryCapitalBanksPersonalBankingResponse : WechatTenpayResponse
{
public static class Types
{
public class Bank : QueryCapitalBanksByBankAccountResponse.Types.Bank
{
}
}
/// <summary>
/// 获取或设置银行列表。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public Types.Bank[] BankList { get; set; } = default!;
/// <summary>
/// 获取或设置分页开始位置。
/// </summary>
[Newtonsoft.Json.JsonProperty("offset")]
[System.Text.Json.Serialization.JsonPropertyName("offset")]
public int Offset { get; set; }
/// <summary>
/// 获取或设置数据总条数。
/// </summary>
[Newtonsoft.Json.JsonProperty("total_count")]
[System.Text.Json.Serialization.JsonPropertyName("total_count")]
public int TotalCount { get; set; }
}
}

View File

@ -0,0 +1,9 @@
{
"data": [
{
"city_name": "北京市",
"city_code": 10
}
],
"total_count": "10"
}

View File

@ -0,0 +1,9 @@
{
"data": [
{
"province_name": "广东省",
"province_code": 22
}
],
"total_count": "10"
}

View File

@ -0,0 +1,14 @@
{
"total_count": "10",
"data": [
{
"bank_branch_name": "中国工商银行上海市周浦支行",
"bank_branch_id": "102290072311"
}
],
"offset": "0",
"account_bank": "招商银行其他银行",
"account_bank_code": 1001,
"bank_alias": "工商银行深圳前海微众银行",
"bank_alias_code": "1000006247"
}

View File

@ -0,0 +1,12 @@
{
"total_count": "10",
"data": [
{
"bank_alias": "工商银行深圳前海微众银行",
"bank_alias_code": "1000006247",
"account_bank": "招商银行其他银行",
"account_bank_code": 1001,
"need_bank_branch": "true"
}
]
}

View File

@ -0,0 +1,13 @@
{
"total_count": "10",
"data": [
{
"bank_alias": "工商银行深圳前海微众银行",
"bank_alias_code": "1000006247",
"account_bank": "招商银行其他银行",
"account_bank_code": 1001,
"need_bank_branch": "true"
}
],
"offset": "0"
}