Merge branch 'main' into feat/authorisation-adjustment

adyen-examples · Aug 1, 2023 · 24f8e71 · 24f8e71
2 parents c144ce5 + 18e42fa
commit 24f8e71
Show file tree

Hide file tree

Showing 22 changed files with 109 additions and 140 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -18,9 +18,7 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v3
     - name: Setup .NET

diff --git a/checkout-example-advanced/Properties/launchSettings.json b/checkout-example-advanced/Properties/launchSettings.json
@@ -8,25 +8,14 @@
     }
   },
   "profiles": {
-    "adyen_dotnet_checkout_example_advanced": {
+    "Checkout Example Advanced": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "applicationUrl": "https://localhost:5001;http://localhost:8080"
     },
-    "adyen_dotnet_checkout_example_advanced_port_tunneling": {
-      "commandName": "Project",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      },
-      "applicationUrl": "https://localhost:5001;http://localhost:8080",
-      // The following two properties enable dev tunnels in visual studio 17.4+. This is used to proxy your localhost and receive webhooks.
-      "devTunnelEnabled": true,
-      "devTunnelAccess": "public"
-    },
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,

diff --git a/checkout-example-advanced/adyen-dotnet-checkout-example-advanced.csproj b/checkout-example-advanced/adyen-dotnet-checkout-example-advanced.csproj
@@ -7,6 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Adyen" Version="10.1.0" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.18" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.19" />
   </ItemGroup>
 </Project>
diff --git a/checkout-example-advanced/readme.md b/checkout-example-advanced/readme.md
@@ -74,10 +74,8 @@ To expose this endpoint locally, we have highlighted two options in step 4 or 5.
 
 
 4. Expose your localhost with Visual Studio using dev tunnels.
-    - Add `https://*.devtunnels.ms` to your allowed origins
-    - Login to Visual Studio
-    - Under `Options` → `Environment` → `Preview Features` → Check `Enable dev tunnels for Web Application`
-    - Select `adyen_dotnet_checkout_example_port_tunneling` as your launch settings profile
+     - Add `https://*.devtunnels.ms` to your allowed origins
+     - Create your public (temporary/persistent) dev tunnel by following [this guide](https://learn.microsoft.com/en-us/aspnet/core/test/dev-tunnels?view=aspnetcore-7.0)
 
 If you use Visual Studio 17.4 or higher, the webhook URL will be the generated URL (i.e. `https://xd1r2txt-5001.euw.devtunnels.ms`).
 
@@ -134,7 +132,7 @@ set ADYEN_HMAC_KEY=yourAdyenHmacKey
 
 
 ```shell
-dotnet run --project checkout-example 
+dotnet run --project checkout-example-advanced
 ```
 
 10. Update your webhook in your Customer Area with the public url that is generated.

diff --git a/checkout-example/Properties/launchSettings.json b/checkout-example/Properties/launchSettings.json
@@ -8,25 +8,14 @@
     }
   },
   "profiles": {
-    "adyen_dotnet_checkout_example": {
+    "Checkout Example": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "applicationUrl": "https://localhost:5001;http://localhost:8080"
     },
-    "adyen_dotnet_checkout_example_port_tunneling": {
-      "commandName": "Project",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      },
-      "applicationUrl": "https://localhost:5001;http://localhost:8080",
-      // The following two properties enable dev tunnels in visual studio 17.4+. This is used to proxy your localhost and receive webhooks.
-      "devTunnelEnabled": true,
-      "devTunnelAccess": "public"
-    },
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,

diff --git a/checkout-example/adyen-dotnet-checkout-example.csproj b/checkout-example/adyen-dotnet-checkout-example.csproj
@@ -7,6 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Adyen" Version="10.1.0" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.18" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.19" />
   </ItemGroup>
 </Project>
diff --git a/checkout-example/readme.md b/checkout-example/readme.md
@@ -72,12 +72,9 @@ git clone https://github.com/adyen-examples/adyen-dotnet-online-payments.git
 This demo provides a simple webhook integration at `/api/webhooks/notifications`. For it to work, you need to provide a way for Adyen's servers to reach your running application and add a standard webhook in the Customer Area.
 To expose this endpoint locally, we have highlighted two options in step 4 or 5. Choose one or consider alternative tunneling software.
 
-
 4. Expose your localhost with Visual Studio using dev tunnels.
-    - Add `https://*.devtunnels.ms` to your allowed origins
-    - Login to Visual Studio
-    - Under `Options` → `Environment` → `Preview Features` → Check `Enable dev tunnels for Web Application`
-    - Select `adyen_dotnet_checkout_example_port_tunneling` as your launch settings profile
+     - Add `https://*.devtunnels.ms` to your allowed origins
+     - Create your public (temporary/persistent) dev tunnel by following [this guide](https://learn.microsoft.com/en-us/aspnet/core/test/dev-tunnels?view=aspnetcore-7.0)
 
 If you use Visual Studio 17.4 or higher, the webhook URL will be the generated URL (i.e. `https://xd1r2txt-5001.euw.devtunnels.ms`).
 

diff --git a/giftcard-example/Properties/launchSettings.json b/giftcard-example/Properties/launchSettings.json
@@ -8,25 +8,14 @@
     }
   },
   "profiles": {
-    "adyen_dotnet_giftcard_example": {
+    "Gift Card Example": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "applicationUrl": "https://localhost:5001;http://localhost:8080"
     },
-    "adyen_dotnet_giftcard_example_port_tunneling": {
-      "commandName": "Project",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      },
-      "applicationUrl": "https://localhost:5001;http://localhost:8080", 
-      // The following two properties enable dev tunnels in visual studio 17.4+. This is used to proxy your localhost and receive webhooks.
-      "devTunnelEnabled": true,
-      "devTunnelAccess": "public"
-    },
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,

diff --git a/giftcard-example/adyen-dotnet-giftcard-example.csproj b/giftcard-example/adyen-dotnet-giftcard-example.csproj
@@ -7,6 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Adyen" Version="10.1.0" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.18" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.19" />
   </ItemGroup>
 </Project>
diff --git a/giftcard-example/readme.md b/giftcard-example/readme.md
@@ -69,12 +69,9 @@ git clone https://github.com/adyen-examples/adyen-dotnet-online-payments.git
 This demo provides a simple webhook integration at `/api/webhooks/notifications`. For it to work, you need to provide a way for Adyen's servers to reach your running application and add a standard webhook in the Customer Area.
 To expose this endpoint locally, we have highlighted two options in step 4 or 5. Choose one or consider alternative tunneling software.
 
-
 4. Expose your localhost with Visual Studio using dev tunnels.
-    - Add `https://*.devtunnels.ms` to your allowed origins
-    - Login to Visual Studio
-    - Under `Options` → `Environment` → `Preview Features` → Check `Enable dev tunnels for Web Application`
-    - Select `adyen_dotnet_giftcard_example_port_tunneling` as your launch settings profile
+     - Add `https://*.devtunnels.ms` to your allowed origins
+     - Create your public (temporary/persistent) dev tunnel by following [this guide](https://learn.microsoft.com/en-us/aspnet/core/test/dev-tunnels?view=aspnetcore-7.0)
 
 If you use Visual Studio 17.4 or higher, the webhook URL will be the generated URL (i.e. `https://xd1r2txt-5001.euw.devtunnels.ms`).
 

diff --git a/paybylink-example/Properties/launchSettings.json b/paybylink-example/Properties/launchSettings.json
@@ -8,25 +8,14 @@
     }
   },
   "profiles": {
-    "adyen_dotnet_paybylink_example": {
+    "Pay By Link Example": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "applicationUrl": "https://localhost:5001;http://localhost:8080"
     },
-    "adyen_dotnet_paybylink_example_port_tunneling": {
-      "commandName": "Project",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      },
-      "applicationUrl": "https://localhost:5001;http://localhost:8080",
-      // The following two properties enable dev tunnels in visual studio 17.4+. This is used to proxy your localhost and receive webhooks.
-      "devTunnelEnabled": true,
-      "devTunnelAccess": "public"
-    },
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,

diff --git a/paybylink-example/adyen-dotnet-paybylink-example.csproj b/paybylink-example/adyen-dotnet-paybylink-example.csproj
@@ -7,6 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Adyen" Version="10.1.0" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.18" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.19" />
   </ItemGroup>
 </Project>
diff --git a/paybylink-example/readme.md b/paybylink-example/readme.md
@@ -66,10 +66,8 @@ To expose this endpoint locally, we have highlighted two options in step 4 or 5.
 
 
 4. Expose your localhost with Visual Studio using dev tunnels.
-    - Add `https://*.devtunnels.ms` to your allowed origins
-    - Login to Visual Studio
-    - Under `Options` → `Environment` → `Preview Features` → Check `Enable dev tunnels for Web Application`
-    - Select `adyen_dotnet_paybylink_example_port_tunneling` as your launch settings profile
+     - Add `https://*.devtunnels.ms` to your allowed origins
+     - Create your public (temporary/persistent) dev tunnel by following [this guide](https://learn.microsoft.com/en-us/aspnet/core/test/dev-tunnels?view=aspnetcore-7.0)
 
 If you use Visual Studio 17.4 or higher, the webhook URL will be the generated URL (i.e. `https://xd1r2txt-5001.euw.devtunnels.ms`).
 

diff --git a/subscription-example/Controllers/AdminController.cs b/subscription-example/Controllers/AdminController.cs
@@ -1,10 +1,11 @@
 using Adyen.HttpClient;
 using Adyen.Model.Checkout;
 using Adyen.Model.Recurring;
-using adyen_dotnet_subscription_example.Clients;
 using adyen_dotnet_subscription_example.Models;
 using adyen_dotnet_subscription_example.Repositories;
+using adyen_dotnet_subscription_example.Services;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
@@ -13,15 +14,17 @@ namespace adyen_dotnet_subscription_example.Controllers
 {
     public class AdminController : Controller
     {
-        private readonly IRecurringClient _recurringClient;
-        private readonly ICheckoutClient _checkoutClient;
+        private readonly ISubscriptionService _subscriptionService;
+        private readonly ICheckoutService _checkoutClient;
         private readonly ISubscriptionRepository _repository;
+        private readonly ILogger<AdminController> _logger;
 
-        public AdminController(IRecurringClient recurringClient, ICheckoutClient checkoutClient, ISubscriptionRepository repository)
+        public AdminController(ISubscriptionService subscriptionService, ICheckoutService checkoutClient, ISubscriptionRepository repository, ILogger<AdminController> logger)
         {
-            _recurringClient = recurringClient;
+            _subscriptionService = subscriptionService;
             _checkoutClient = checkoutClient;
             _repository = repository;
+            _logger = logger;
         }
 
         [Route("admin")]
@@ -58,10 +61,11 @@ public async Task<IActionResult> MakePayment(string recurringDetailReference, Ca
                         break;
                 }
             }   
-            catch (HttpClientException)
+            catch (HttpClientException e)
             {
                 ViewBag.Message = $"Payment failed for RecurringDetailReference {recurringDetailReference}. See error logs for the exception.";
                 ViewBag.Img = "failed";
+                _logger.LogError($"Payment failed for RecurringDetailReference {recurringDetailReference}: \n{e.ResponseBody}\n");
             }
             return View();
         }
@@ -71,7 +75,7 @@ public async Task<IActionResult> Disable(string recurringDetailReference, Cancel
         {
             try
             {
-                DisableResult result = await _recurringClient.DisableRecurringDetailAsync(ShopperReference.Value, recurringDetailReference, cancellationToken);
+                DisableResult result = await _subscriptionService.DisableRecurringDetailAsync(ShopperReference.Value, recurringDetailReference, cancellationToken);
 
                 switch (result.Response)
                 {
@@ -85,10 +89,11 @@ public async Task<IActionResult> Disable(string recurringDetailReference, Cancel
                         break;
                 }
             }
-            catch (HttpClientException)
+            catch (HttpClientException e)
             {
                 ViewBag.Message = $"Disable failed for RecurringDetailReference {recurringDetailReference}. See error logs for the exception.";
                 ViewBag.Img = "failed";
+                _logger.LogError($"Disable failed for RecurringDetailReference {recurringDetailReference}: \n{e.ResponseBody}\n");
             }
             return View();
         }

diff --git a/subscription-example/Controllers/TokenizationController.cs b/subscription-example/Controllers/TokenizationController.cs
@@ -1,17 +1,17 @@
-using adyen_dotnet_subscription_example.Clients;
-using Adyen.Model.Checkout;
+using Adyen.Model.Checkout;
 using Microsoft.AspNetCore.Mvc;
 using System.Threading;
 using System.Threading.Tasks;
+using adyen_dotnet_subscription_example.Services;
 
 namespace adyen_dotnet_subscription_example.Controllers
 {
     [ApiController]
     public class TokenizationController : ControllerBase
     {
-        private readonly ICheckoutClient _checkoutService;
+        private readonly ICheckoutService _checkoutService;
 
-        public TokenizationController(ICheckoutClient checkoutService)
+        public TokenizationController(ICheckoutService checkoutService)
         {
             _checkoutService = checkoutService;
         }

diff --git a/subscription-example/Controllers/WebhookController.cs b/subscription-example/Controllers/WebhookController.cs
@@ -51,8 +51,10 @@ public async Task<ActionResult<string>> Webhooks(NotificationRequest notificatio
                     return BadRequest("[not accepted invalid hmac key]");
                 }
 
-                // Process notification asynchronously.
-                await ProcessNotificationAsync(container.NotificationItem);
+                // Process notifications asynchronously.
+                await ProcessAuthorisationNotificationAsync(container.NotificationItem);
+
+                await ProcessRecurringContractNotificationAsync(container.NotificationItem);
 
                 return Ok("[accepted]");
             }
@@ -63,18 +65,42 @@ public async Task<ActionResult<string>> Webhooks(NotificationRequest notificatio
             }
         }
 
-        private Task ProcessNotificationAsync(NotificationRequestItem notification)
+        private Task ProcessAuthorisationNotificationAsync(NotificationRequestItem notification)
         {
-            // (1) For the synchronous flow (enabled by default), check the "Authorisation" eventCode: 
-            // Read more: https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens?tab=subscriptions_2#authorised-result-code-1
-
-            // (2) For the asynchronous flow, (enabled by contacting our support team), you need to check the "RECURRING_CONTRACT" eventCode instead of the "AUTHORISATION" eventCode.
-            // Read more: https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens?tab=subscriptions_2#pending-and-refusal-result-codes-1
+            // Read more here: https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens?tab=subscriptions_2#pending-and-refusal-result-codes-1
             if (notification.EventCode != "AUTHORISATION")
             {
                 return Task.CompletedTask;
             }
 
+            // Perform your business logic here for the success:false scenario. 
+            if (!notification.Success)
+            {
+                // We just log it for now. You would probably want to update your backend or send this the message to a queue.
+                _logger.LogInformation($"Webhook unsuccessful: {notification.Reason} \n" +
+                    $"EventCode: {notification.EventCode} \n" +
+                    $"Merchant Reference ::{notification.MerchantReference} \n" +
+                    $"PSP Reference ::{notification.PspReference} \n");
+
+                return Task.CompletedTask;
+            }
+
+            _logger.LogInformation($"Received webhook with event: \n" +
+                $"EventCode: {notification.EventCode} \n" +
+                $"Merchant Reference: {notification.MerchantReference} \n" +
+                $"PSP Reference: {notification.PspReference} \n");
+            return Task.CompletedTask;
+        }
+
+
+        private Task ProcessRecurringContractNotificationAsync(NotificationRequestItem notification)
+        {
+            // Read more about EventCode "RECURRING_CONTRACT" here: https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens?tab=subscriptions_2#pending-and-refusal-result-codes-1.
+            if (notification.EventCode != "RECURRING_CONTRACT")
+            {
+                return Task.CompletedTask;
+            }
+
             // Perform your business logic here for the success:false scenario.
             if (!notification.Success)
             {
@@ -101,17 +127,19 @@ private Task ProcessNotificationAsync(NotificationRequestItem notification)
             }
 
             // Get and log the recurringProcessingModel below.
-            notification.AdditionalData.TryGetValue("recurringProcessingModel", out string recurringProcessingModel);
-
-            _logger.LogInformation($"Received recurringDetailReference: {recurringDetailReference} for {shopperReference}" +
-                $"RecurringProcessingModel: {recurringProcessingModel}");
+            if (notification.AdditionalData.TryGetValue("recurringProcessingModel", out string recurringProcessingModel))
+            {
+                _logger.LogInformation($"EventCode: {notification.EventCode} \nReceived recurringDetailReference: {recurringDetailReference} for {shopperReference} \n" +
+                    $"RecurringProcessingModel: {recurringProcessingModel}");
+            }
 
             // Save the paymentMethod, shopperReference and recurringDetailReference in our in-memory cache.
             _repository.Upsert(notification.PaymentMethod, shopperReference, recurringDetailReference);
 
             _logger.LogInformation($"Received webhook with event: \n" +
-                                   $"Merchant Reference: {notification.MerchantReference} \n" +
-                                   $"PSP Reference: {notification.PspReference} \n");
+                $"EventCode: {notification.EventCode} \n" +
+                $"Merchant Reference: {notification.MerchantReference} \n" +
+                $"PSP Reference: {notification.PspReference} \n");
             return Task.CompletedTask;
         }
     }