support commerce's new partial refund feature (#14)

Author: umbracotrd

Directory.Packages.props

@@ -11,6 +11,6 @@
   </ItemGroup>
   <ItemGroup>
     <PackageVersion Include="Flurl.Http" Version="[4.0.2, 5)" />
-    <PackageVersion Include="Umbraco.Commerce.Core" Version="[15.0.0, 15.999.999)" />
+    <PackageVersion Include="Umbraco.Commerce.Core" Version="[15.3.0, 15.999.999)" />
   </ItemGroup>
 </Project>

src/Umbraco.Commerce.PaymentProviders.Quickpay/QuickpayCheckoutPaymentProvider.cs

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Net.Http;
 using System.Security.Cryptography;
 using System.Text;
 using System.Text.Json;
@@ -31,16 +30,17 @@ public QuickpayCheckoutPaymentProvider(UmbracoCommerceContext ctx, ILogger<Quick
         public override bool CanCancelPayments => true;
         public override bool CanCapturePayments => true;
         public override bool CanRefundPayments => true;
+        public override bool CanPartiallyRefundPayments => true;
         public override bool CanFetchPaymentStatus => true;
 
         public override bool FinalizeAtContinueUrl => false;
 
-        public override IEnumerable<TransactionMetaDataDefinition> TransactionMetaDataDefinitions => new[]
-        {
-            new TransactionMetaDataDefinition("quickpayOrderId", "Quickpay Order ID"),
-            new TransactionMetaDataDefinition("quickpayPaymentId", "Quickpay Payment ID"),
-            new TransactionMetaDataDefinition("quickpayPaymentHash", "Quickpay Payment Hash")
-        };
+        public override IEnumerable<TransactionMetaDataDefinition> TransactionMetaDataDefinitions =>
+        [
+            new TransactionMetaDataDefinition("quickpayOrderId"),
+            new TransactionMetaDataDefinition("quickpayPaymentId"),
+            new TransactionMetaDataDefinition("quickpayPaymentHash")
+        ];
 
         public override async Task<PaymentFormResult> GenerateFormAsync(PaymentProviderContext<QuickpayCheckoutSettings> ctx, CancellationToken cancellationToken = default)
         {
@@ -383,35 +383,55 @@ public override async Task<ApiResult> CapturePaymentAsync(PaymentProviderContext
             return ApiResult.Empty;
         }
 
-        public override async Task<ApiResult> RefundPaymentAsync(PaymentProviderContext<QuickpayCheckoutSettings> ctx, CancellationToken cancellationToken = default)
+        [Obsolete("Will be removed in v17. Use the overload that takes an order refund request instead.")]
+        public override async Task<ApiResult?> RefundPaymentAsync(PaymentProviderContext<QuickpayCheckoutSettings> context, CancellationToken cancellationToken = default)
         {
-            // POST: /payments/{id}/refund
+            ArgumentNullException.ThrowIfNull(context);
+
+            StoreReadOnly store = await Context.Services.StoreService.GetStoreAsync(context.Order.StoreId);
+            Amount refundAmount = store.CanRefundTransactionFee ? context.Order.TransactionInfo.AmountAuthorized + context.Order.TransactionInfo.TransactionFee : context.Order.TransactionInfo.AmountAuthorized;
+            return await this.RefundPaymentAsync(
+                context,
+                new PaymentProviderOrderRefundRequest
+                {
+                    RefundAmount = refundAmount,
+                    Orderlines = context.Order.OrderLines.Select(x => new PaymentProviderOrderlineRefundRequest
+                    {
+                        OrderLineId = x.Id,
+                        Quantity = x.Quantity,
+                    }),
+                },
+                cancellationToken);
+        }
 
+        public override async Task<ApiResult?> RefundPaymentAsync(PaymentProviderContext<QuickpayCheckoutSettings> context, PaymentProviderOrderRefundRequest refundRequest, CancellationToken cancellationToken = default)
+        {
+            ArgumentNullException.ThrowIfNull(context);
+            ArgumentNullException.ThrowIfNull(refundRequest);
             try
             {
-                var id = ctx.Order.TransactionInfo.TransactionId;
+                string id = context.Order.TransactionInfo.TransactionId;
 
-                var clientConfig = GetQuickpayClientConfig(ctx.Settings);
-                var client = new QuickpayClient(clientConfig);
+                QuickpayClientConfig clientConfig = GetQuickpayClientConfig(context.Settings);
+                QuickpayClient client = new(clientConfig);
 
-                var payment = await client.RefundPaymentAsync(id, new
-                {
-                    amount = AmountToMinorUnits(ctx.Order.TransactionInfo.AmountAuthorized.Value)
-                },
-                cancellationToken);
+                QuickpayPayment payment = await client.RefundPaymentAsync(
+                    id,
+                    new { amount = AmountToMinorUnits(refundRequest.RefundAmount) },
+                    cancellationToken);
 
-                Operation lastCompletedOperation = payment.Operations.LastOrDefault(o => !o.Pending && o.QuickpayStatusCode == "20000");
+                Operation? lastCompletedOperation = payment.Operations.LastOrDefault(o => !o.Pending && o.QuickpayStatusCode == "20000");
 
                 if (lastCompletedOperation != null)
                 {
-                    var paymentStatus = GetPaymentStatus(lastCompletedOperation);
+                    PaymentStatus paymentStatus = GetPaymentStatus(lastCompletedOperation);
 
                     return new ApiResult()
                     {
                         TransactionInfo = new TransactionInfoUpdate()
                         {
                             TransactionId = GetTransactionId(payment),
-                            PaymentStatus = paymentStatus
+                            PaymentStatus = paymentStatus,
                         }
                     };
                 }

src/Umbraco.Commerce.PaymentProviders.Quickpay/Umbraco.Commerce.PaymentProviders.Quickpay.csproj

@@ -4,6 +4,8 @@
       <Title>Umbraco Commerce Quickpay Payment Provider</Title>
       <Description>Quickpay payment provider for Umbraco Commerce</Description>
       <StaticWebAssetBasePath>App_Plugins/UmbracoCommerceQuickpayPaymentProvider</StaticWebAssetBasePath>
+      <NoWarn>IDE0290;IDE0058;CA2007;IDE0021;IDE0022;</NoWarn>
+      <Nullable>enable</Nullable>
     </PropertyGroup>
 
     <ItemGroup>