Generate ACS webhooks

Author: gcatanese

src/__tests__/notification.spec.ts

@@ -311,4 +311,79 @@ describe("Notification Test", function (): void {
         expect(negativeBalanceCompensationWarningNotificationRequest.data.id).toBe("BA00000000000000000001");
         expect(negativeBalanceCompensationWarningNotificationRequest.data.creationDate?.toISOString()).toBe(new Date("2024-07-02T02:01:08+02:00").toISOString());
     });
+
+    it("should deserialize AcsWebhook AuthenticationNotificationRequest", function (): void {
+        const json = {
+            "data": {
+              "authentication": {
+                "acsTransId": "6a4c1709-a42e-4c7f-96c7-1043adacfc97",
+                "challenge": {
+                  "flow": "OOB",
+                  "lastInteraction": "2022-12-22T15:49:03+01:00"
+                },
+                "challengeIndicator": "01",
+                "createdAt": "2022-12-22T15:45:03+01:00",
+                "deviceChannel": "app",
+                "dsTransID": "a3b86754-444d-46ca-95a2-ada351d3f42c",
+                "exemptionIndicator": "lowValue",
+                "inPSD2Scope": true,
+                "messageCategory": "payment",
+                "messageVersion": "2.2.0",
+                "riskScore": 0,
+                "threeDSServerTransID": "6edcc246-23ee-4e94-ac5d-8ae620bea7d9",
+                "transStatus": "Y",
+                "type": "challenge"
+              },
+              "balancePlatform": "YOUR_BALANCE_PLATFORM",
+              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
+              "paymentInstrumentId": "PI3227C223222B5BPCMFXD2XG",
+              "purchase": {
+                "date": "2022-12-22T15:49:03+01:00",
+                "merchantName": "TeaShop_NL",
+                "originalAmount": {
+                  "currency": "EUR",
+                  "value": 1000
+                }
+              },
+              "status": "authenticated"
+            },
+            "environment": "test",
+            "timestamp": "2022-12-22T15:42:03+01:00",
+            "type": "balancePlatform.authentication.created"
+          };
+        const jsonString = JSON.stringify(json);
+        const bankingWebhookHandler = new BankingWebhookHandler(jsonString);
+        const authenticationNotificationRequest = bankingWebhookHandler.getAuthenticationNotificationRequest();
+        expect(authenticationNotificationRequest).toBeTruthy();
+        expect(authenticationNotificationRequest.type).toBe(AuthenticationNotificationRequest
+            .TypeEnum.BalancePlatformAuthenticationCreated
+        );
+        expect(authenticationNotificationRequest.environment).toBe("test");
+        expect(authenticationNotificationRequest.timestamp?.toISOString()).toBe(new Date("2022-12-22T15:42:03+01:00").toISOString());
+        expect(authenticationNotificationRequest.data).toBeDefined();
+        expect(authenticationNotificationRequest.data.balancePlatform).toBe("YOUR_BALANCE_PLATFORM");
+        expect(authenticationNotificationRequest.data.id).toBe("497f6eca-6276-4993-bfeb-53cbbbba6f08");
+    });
+
+    it("should deserialize AcsWebhook RelayedAuthenticationRequest", function (): void {
+        const json = {
+            "id": "1ea64f8e-d1e1-4b9d-a3a2-3953e385b2c8",
+            "paymentInstrumentId": "PI123ABCDEFGHIJKLMN45678",
+            "purchase": {
+              "date": "2025-03-06T15:17:55Z",
+              "merchantName": "widgetsInc",
+              "originalAmount": {
+                "currency": "EUR",
+                "value": 14548
+              }
+            }
+          };
+        const jsonString = JSON.stringify(json);
+        const bankingWebhookHandler = new BankingWebhookHandler(jsonString);
+        const relayedAuthenticationRequest = bankingWebhookHandler.getRelayedAuthenticationRequest();
+        expect(relayedAuthenticationRequest).toBeTruthy();
+        expect(relayedAuthenticationRequest.id).toBe("1ea64f8e-d1e1-4b9d-a3a2-3953e385b2c8");
+        expect(relayedAuthenticationRequest.paymentInstrumentId).toBe("PI123ABCDEFGHIJKLMN45678");
+        expect(relayedAuthenticationRequest.purchase).toBeDefined();
+    });
 });

src/notification/bankingWebhookHandler.ts

@@ -16,6 +16,7 @@ class BankingWebhookHandler {
 
     // Return generic webhook type
     public getGenericWebhook(): acsWebhooks.AuthenticationNotificationRequest
+        | acsWebhooks.RelayedAuthenticationRequest
         | configurationWebhooks.AccountHolderNotificationRequest
         | configurationWebhooks.BalanceAccountNotificationRequest
         | configurationWebhooks.PaymentNotificationRequest
@@ -67,13 +68,23 @@ class BankingWebhookHandler {
             return this.getTransactionNotificationRequest();
         }
 
+        if(!type && this.payload["paymentInstrumentId"]){
+            // ad-hoc fix for the relayed authentication request
+            // if type is undefined but paymentInstrumentId is present then it is a relayedAuthenticationRequest
+            return this.getRelayedAuthenticationRequest();
+        }
+
         throw new Error("Could not parse the json payload: " + this.payload);
     }
 
     public getAuthenticationNotificationRequest(): acsWebhooks.AuthenticationNotificationRequest {
         return acsWebhooks.ObjectSerializer.deserialize(this.payload, "AuthenticationNotificationRequest");
     }
 
+    public getRelayedAuthenticationRequest(): acsWebhooks.RelayedAuthenticationRequest {
+        return acsWebhooks.ObjectSerializer.deserialize(this.payload, "RelayedAuthenticationRequest");
+    }
+
     public getAccountHolderNotificationRequest(): configurationWebhooks.AccountHolderNotificationRequest {
         return configurationWebhooks.ObjectSerializer.deserialize(this.payload, "AccountHolderNotificationRequest");
     }

src/typings/acsWebhooks/authenticationDecision.ts

@@ -0,0 +1,36 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+export class AuthenticationDecision {
+    /**
+    * The status of the authentication.   Possible values:   * **refused**   * **proceed**   For more information, refer to [Authenticate cardholders using the Authentication SDK](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/authenticate-cardholders/).
+    */
+    'status': AuthenticationDecision.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "AuthenticationDecision.StatusEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AuthenticationDecision.attributeTypeMap;
+    }
+}
+
+export namespace AuthenticationDecision {
+    export enum StatusEnum {
+        Proceed = 'proceed',
+        Refused = 'refused'
+    }
+}

src/typings/acsWebhooks/challengeInfo.ts

@@ -14,7 +14,7 @@ export class ChallengeInfo {
     */
     'challengeCancel'?: ChallengeInfo.ChallengeCancelEnum;
     /**
-    * The flow used in the challenge. Possible values:  * **OTP_SMS**: one-time password (OTP) flow * **OOB**: out-of-band (OOB) flow
+    * The flow used in the challenge. Possible values:  * **PWD_OTP_PHONE_FL**: one-time password (OTP) flow via SMS * **PWD_OTP_EMAIL_FL**: one-time password (OTP) flow via email * **OOB_TRIGGER_FL**: out-of-band (OOB) flow
     */
     'flow': ChallengeInfo.FlowEnum;
     /**
@@ -86,7 +86,8 @@ export namespace ChallengeInfo {
         _08 = '08'
     }
     export enum FlowEnum {
-        OtpSms = 'OTP_SMS',
-        Oob = 'OOB'
+        PwdOtpPhoneFl = 'PWD_OTP_PHONE_FL',
+        PwdOtpEmailFl = 'PWD_OTP_EMAIL_FL',
+        OobTriggerFl = 'OOB_TRIGGER_FL'
     }
 }

src/typings/acsWebhooks/models.ts

@@ -9,23 +9,33 @@
 
 
 export * from './amount';
+export * from './authenticationDecision';
 export * from './authenticationInfo';
 export * from './authenticationNotificationData';
 export * from './authenticationNotificationRequest';
 export * from './balancePlatformNotificationResponse';
 export * from './challengeInfo';
+export * from './purchase';
 export * from './purchaseInfo';
+export * from './relayedAuthenticationRequest';
+export * from './relayedAuthenticationResponse';
 export * from './resource';
+export * from './serviceError';
 
 
 import { Amount } from './amount';
+import { AuthenticationDecision } from './authenticationDecision';
 import { AuthenticationInfo } from './authenticationInfo';
 import { AuthenticationNotificationData } from './authenticationNotificationData';
 import { AuthenticationNotificationRequest } from './authenticationNotificationRequest';
 import { BalancePlatformNotificationResponse } from './balancePlatformNotificationResponse';
 import { ChallengeInfo } from './challengeInfo';
+import { Purchase } from './purchase';
 import { PurchaseInfo } from './purchaseInfo';
+import { RelayedAuthenticationRequest } from './relayedAuthenticationRequest';
+import { RelayedAuthenticationResponse } from './relayedAuthenticationResponse';
 import { Resource } from './resource';
+import { ServiceError } from './serviceError';
 
 /* tslint:disable:no-unused-variable */
 let primitives = [
@@ -40,6 +50,7 @@ let primitives = [
                  ];
 
 let enumsMap: {[index: string]: any} = {
+        "AuthenticationDecision.StatusEnum": AuthenticationDecision.StatusEnum,
         "AuthenticationInfo.ChallengeIndicatorEnum": AuthenticationInfo.ChallengeIndicatorEnum,
         "AuthenticationInfo.DeviceChannelEnum": AuthenticationInfo.DeviceChannelEnum,
         "AuthenticationInfo.ExemptionIndicatorEnum": AuthenticationInfo.ExemptionIndicatorEnum,
@@ -55,13 +66,18 @@ let enumsMap: {[index: string]: any} = {
 
 let typeMap: {[index: string]: any} = {
     "Amount": Amount,
+    "AuthenticationDecision": AuthenticationDecision,
     "AuthenticationInfo": AuthenticationInfo,
     "AuthenticationNotificationData": AuthenticationNotificationData,
     "AuthenticationNotificationRequest": AuthenticationNotificationRequest,
     "BalancePlatformNotificationResponse": BalancePlatformNotificationResponse,
     "ChallengeInfo": ChallengeInfo,
+    "Purchase": Purchase,
     "PurchaseInfo": PurchaseInfo,
+    "RelayedAuthenticationRequest": RelayedAuthenticationRequest,
+    "RelayedAuthenticationResponse": RelayedAuthenticationResponse,
     "Resource": Resource,
+    "ServiceError": ServiceError,
 }
 
 export class ObjectSerializer {

src/typings/acsWebhooks/purchase.ts

@@ -0,0 +1,46 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { Amount } from './amount';
+
+export class Purchase {
+    /**
+    * The time of the purchase.
+    */
+    'date': Date;
+    /**
+    * The name of the merchant.
+    */
+    'merchantName': string;
+    'originalAmount': Amount;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "date",
+            "baseName": "date",
+            "type": "Date"
+        },
+        {
+            "name": "merchantName",
+            "baseName": "merchantName",
+            "type": "string"
+        },
+        {
+            "name": "originalAmount",
+            "baseName": "originalAmount",
+            "type": "Amount"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Purchase.attributeTypeMap;
+    }
+}
+

src/typings/acsWebhooks/relayedAuthenticationRequest.ts

@@ -0,0 +1,46 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { Purchase } from './purchase';
+
+export class RelayedAuthenticationRequest {
+    /**
+    * The unique identifier of the challenge.
+    */
+    'id': string;
+    /**
+    * The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_) used for the purchase.
+    */
+    'paymentInstrumentId': string;
+    'purchase': Purchase;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "paymentInstrumentId",
+            "baseName": "paymentInstrumentId",
+            "type": "string"
+        },
+        {
+            "name": "purchase",
+            "baseName": "purchase",
+            "type": "Purchase"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RelayedAuthenticationRequest.attributeTypeMap;
+    }
+}
+

src/typings/acsWebhooks/relayedAuthenticationResponse.ts

@@ -0,0 +1,28 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { AuthenticationDecision } from './authenticationDecision';
+
+export class RelayedAuthenticationResponse {
+    'authenticationDecision': AuthenticationDecision;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "authenticationDecision",
+            "baseName": "authenticationDecision",
+            "type": "AuthenticationDecision"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RelayedAuthenticationResponse.attributeTypeMap;
+    }
+}
+