Merge pull request #294 from commercetools/dasanorct/SCC-2774_merchan…

…t_reference

feat(payments): accept a merchant reference in payment intents API

processor/package.json

@@ -23,7 +23,7 @@
   "dependencies": {
     "@adyen/api-library": "22.1.0",
     "@commercetools-backend/loggers": "22.38.1",
-    "@commercetools/connect-payments-sdk": "0.15.0",
+    "@commercetools/connect-payments-sdk": "0.16.0",
     "@fastify/autoload": "6.0.3",
     "@fastify/cors": "10.0.2",
     "@fastify/formbody": "8.0.2",

processor/src/dtos/operations/payment-intents.dto.ts

@@ -11,6 +11,7 @@ export const ActionCapturePaymentSchema = Type.Composite([
   }),
   Type.Object({
     amount: AmountSchema,
+    merchantReference: Type.Optional(Type.String()),
   }),
 ]);
 
@@ -20,12 +21,14 @@ export const ActionRefundPaymentSchema = Type.Composite([
   }),
   Type.Object({
     amount: AmountSchema,
+    merchantReference: Type.Optional(Type.String()),
   }),
 ]);
 
 export const ActionCancelPaymentSchema = Type.Composite([
   Type.Object({
     action: Type.Literal('cancelPayment'),
+    merchantReference: Type.Optional(Type.String()),
   }),
 ]);
 

processor/src/services/abstract-payment.service.ts

@@ -106,7 +106,12 @@ export abstract class AbstractPaymentService {
       action: request.action,
     });
 
-    const res = await this.processPaymentModification(updatedPayment, transactionType, requestAmount);
+    const res = await this.processPaymentModification(
+      updatedPayment,
+      transactionType,
+      requestAmount,
+      request.merchantReference,
+    );
 
     updatedPayment = await this.ctPaymentService.updatePayment({
       id: ctPayment.id,
@@ -151,16 +156,17 @@ export abstract class AbstractPaymentService {
     payment: Payment,
     transactionType: string,
     requestAmount: AmountSchemaDTO,
+    merchantReference?: string,
   ) {
     switch (transactionType) {
       case 'CancelAuthorization': {
-        return await this.cancelPayment({ payment });
+        return await this.cancelPayment({ payment, merchantReference });
       }
       case 'Charge': {
-        return await this.capturePayment({ amount: requestAmount, payment });
+        return await this.capturePayment({ amount: requestAmount, payment, merchantReference });
       }
       case 'Refund': {
-        return await this.refundPayment({ amount: requestAmount, payment });
+        return await this.refundPayment({ amount: requestAmount, payment, merchantReference });
       }
       default: {
         throw new ErrorInvalidOperation(`Operation ${transactionType} not supported.`);

processor/src/services/adyen-payment.service.ts

@@ -55,6 +55,7 @@ import { RefundPaymentConverter } from './converters/refund-payment.converter';
 import { log } from '../libs/logger';
 import { ApplePayPaymentSessionError, UnsupportedNotificationError } from '../errors/adyen-api.error';
 import { fetch as undiciFetch, Agent, Dispatcher } from 'undici';
+import { NotificationUpdatePayment } from './types/service.type';
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const packageJSON = require('../../package.json');
 
@@ -380,10 +381,11 @@ export class AdyenPaymentService extends AbstractPaymentService {
     log.info('Processing notification', { notification: JSON.stringify(opts.data) });
     try {
       const updateData = this.notificationConverter.convert(opts);
+      const payment = await this.getPaymentFromNotification(updateData);
 
       for (const tx of updateData.transactions) {
         const updatedPayment = await this.ctPaymentService.updatePayment({
-          id: updateData.id,
+          id: payment.id,
           pspReference: updateData.pspReference,
           transaction: tx,
         });
@@ -564,4 +566,34 @@ export class AdyenPaymentService extends AbstractPaymentService {
     }
     return redirectUrl.toString();
   }
+
+  /**
+   * Retrieves a payment instance from the notification data
+   * First, it tries to find the payment by the interfaceId (PSP reference)
+   * As a fallback, it tries to find the payment by the merchantReference which unless the merchant overrides it, it's the payment ID
+   * @param data
+   * @returns A payment instance
+   */
+  private async getPaymentFromNotification(data: NotificationUpdatePayment): Promise<Payment> {
+    const interfaceId = data.pspReference;
+    let payment!: Payment;
+
+    if (interfaceId) {
+      const results = await this.ctPaymentService.findPaymentsByInterfaceId({
+        interfaceId,
+      });
+
+      if (results.length > 0) {
+        payment = results[0];
+      }
+    }
+
+    if (!payment) {
+      return await this.ctPaymentService.getPayment({
+        id: data.merchantReference,
+      });
+    }
+
+    return payment;
+  }
 }

processor/src/services/converters/cancel-payment.converter.ts

@@ -6,7 +6,7 @@ export class CancelPaymentConverter {
   public convertRequest(opts: CancelPaymentRequest): PaymentCancelRequest {
     return {
       merchantAccount: config.adyenMerchantAccount,
-      reference: opts.payment.id,
+      reference: opts.merchantReference || opts.payment.id,
     };
   }
 }

processor/src/services/converters/capture-payment.converter.ts

@@ -38,7 +38,7 @@ export class CapturePaymentConverter {
 
     return {
       merchantAccount: config.adyenMerchantAccount,
-      reference: opts.payment.id,
+      reference: opts.merchantReference || opts.payment.id,
       amount: {
         currency: opts.amount.currencyCode,
         value: CurrencyConverters.convertWithMapping({
@@ -47,7 +47,7 @@ export class CapturePaymentConverter {
           currencyCode: opts.amount.currencyCode,
         }),
       },
-      lineItems: adyenLineItems,
+      ...(adyenLineItems && { lineItems: adyenLineItems }),
     };
   }
 

processor/src/services/converters/notification.converter.ts

@@ -11,7 +11,7 @@ export class NotificationConverter {
     const item = opts.data.notificationItems[0].NotificationRequestItem;
 
     return {
-      id: item.merchantReference,
+      merchantReference: item.merchantReference,
       pspReference: item.originalReference || item.pspReference,
       paymentMethod: item.paymentMethod,
       transactions: this.populateTransactions(item),

processor/src/services/converters/refund-payment.converter.ts

@@ -8,7 +8,7 @@ export class RefundPaymentConverter {
   public convertRequest(opts: RefundPaymentRequest): PaymentRefundRequest {
     return {
       merchantAccount: config.adyenMerchantAccount,
-      reference: opts.payment.id,
+      reference: opts.merchantReference || opts.payment.id,
       amount: {
         currency: opts.amount.currencyCode,
         value: CurrencyConverters.convertWithMapping({

processor/src/services/types/operation.type.ts

@@ -10,15 +10,18 @@ import { Payment } from '@commercetools/connect-payments-sdk';
 export type CapturePaymentRequest = {
   amount: AmountSchemaDTO;
   payment: Payment;
+  merchantReference?: string;
 };
 
 export type CancelPaymentRequest = {
   payment: Payment;
+  merchantReference?: string;
 };
 
 export type RefundPaymentRequest = {
   amount: AmountSchemaDTO;
   payment: Payment;
+  merchantReference?: string;
 };
 
 export type PaymentProviderModificationResponse = {

processor/src/services/types/service.type.ts

@@ -1,6 +1,6 @@
 import { TransactionData } from '@commercetools/connect-payments-sdk';
 export type NotificationUpdatePayment = {
-  id: string;
+  merchantReference: string;
   pspReference?: string;
   transactions: TransactionData[];
   paymentMethod?: string;

processor/test/services/adyen-payment.service.spec.ts

@@ -711,14 +711,17 @@ describe('adyen-payment.service', () => {
         ],
       };
 
+      jest
+        .spyOn(DefaultPaymentService.prototype, 'findPaymentsByInterfaceId')
+        .mockResolvedValue([mockUpdatePaymentResult]);
       jest.spyOn(DefaultPaymentService.prototype, 'updatePayment').mockResolvedValue(mockUpdatePaymentResult);
 
       // When
       await paymentService.processNotification({ data: notification });
 
       // Then
       expect(DefaultPaymentService.prototype.updatePayment).toHaveBeenCalledWith({
-        id: merchantReference,
+        id: '123456',
         pspReference,
         transaction: {
           amount: {

processor/test/services/converters/cancel.converter.spec.ts

@@ -0,0 +1,43 @@
+import { describe, test, expect } from '@jest/globals';
+import { mockGetPaymentResult } from '../../utils/mock-payment-data';
+import { config } from '../../../src/config/config';
+import { CancelPaymentConverter } from '../../../src/services/converters/cancel-payment.converter';
+
+describe('cancel.converter', () => {
+  const converter = new CancelPaymentConverter();
+
+  test('convert with checkout merchant reference', async () => {
+    // Arrange
+    const payment = mockGetPaymentResult;
+    const data = {
+      payment,
+    };
+
+    // Act
+    const result = converter.convertRequest(data);
+
+    // Assert
+    expect(result).toEqual({
+      merchantAccount: config.adyenMerchantAccount,
+      reference: mockGetPaymentResult.id,
+    });
+  });
+
+  test('convert with custom merchant reference', async () => {
+    // Arrange
+    const payment = mockGetPaymentResult;
+    const data = {
+      payment,
+      merchantReference: 'merchantReference',
+    };
+
+    // Act
+    const result = converter.convertRequest(data);
+
+    // Assert
+    expect(result).toEqual({
+      merchantAccount: config.adyenMerchantAccount,
+      reference: 'merchantReference',
+    });
+  });
+});