Add isCardLinkOperation

Author: TatianaFomina

src/billing/cloudpayments.ts

@@ -43,11 +43,13 @@ import { PaymentData } from './types/paymentData';
 import cloudPaymentsApi from '../utils/cloudPaymentsApi';
 import PlanModel from '../models/plan';
 import { ClientApi, ClientService, CustomerReceiptItem, ReceiptApi, ReceiptTypes, TaxationSystem } from 'cloudpayments';
+import { ComposePaymentPayload } from './types/composePaymentPayload';
 
-/**
- * Custom data of the plan prolongation request
- */
-type PlanProlongationData = PlanProlongationPayload & PaymentData;
+
+interface ComposePaymentRequest extends express.Request {
+  query: ComposePaymentPayload & { [key: string]: any };
+  context: import('../types/graphql').ResolverContextBase
+};
 
 /**
  * Class for describing the logic of payment routes
@@ -99,8 +101,8 @@ export default class CloudPaymentsWebhooks {
    * @param req — Express request object
    * @param res - Express response object
    */
-  private async composePayment(req: express.Request, res: express.Response): Promise<void> {
-    const { workspaceId, tariffPlanId, shouldSaveCard } = req.query as Record<string, string>;
+  private async composePayment(req: ComposePaymentRequest, res: express.Response): Promise<void> {
+    const { workspaceId, tariffPlanId, shouldSaveCard, isCardLinkOperation } = req.query;
     const userId = req.context.user.id;
 
     if (!workspaceId || !tariffPlanId || !userId) {
@@ -142,6 +144,7 @@ export default class CloudPaymentsWebhooks {
         userId: userId,
         tariffPlanId: tariffPlan._id.toString(),
         shouldSaveCard: shouldSaveCard === 'true',
+        isCardLinkOperation: isCardLinkOperation === 'true',
       });
     } catch (e) {
       const error = e as Error;
@@ -201,7 +204,7 @@ export default class CloudPaymentsWebhooks {
     let member: ConfirmedMemberDBScheme;
     let plan: PlanDBScheme;
 
-    if (!data.workspaceId || !data.tariffPlanId || !data.userId) {
+    if (!data.workspaceId || !data.tariffPlanId || !data.userId || data.isCardLinkOperation === undefined) {
       this.sendError(res, CheckCodes.PAYMENT_COULD_NOT_BE_ACCEPTED, '[Billing / Check] There is no necessary data in the request', body);
 
       return;
@@ -235,6 +238,18 @@ export default class CloudPaymentsWebhooks {
       return;
     }
 
+    if (data.isCardLinkOperation) {
+      telegram
+        .sendMessage(`✅ [Billing / Check] Card linked for subscription workspace «${workspace.name}»`, TelegramBotURLs.Money)
+        .catch(e => console.error('Error while sending message to Telegram: ' + e));
+
+      res.json({
+        code: CheckCodes.SUCCESS,
+      } as CheckResponse);
+
+      return;
+    }
+
     /**
      * Create business operation about creation of subscription
      */
@@ -266,6 +281,7 @@ export default class CloudPaymentsWebhooks {
 
     telegram.sendMessage(`✅ [Billing / Check] All checks passed successfully «${workspace.name}»`, TelegramBotURLs.Money)
       .catch(e => console.error('Error while sending message to Telegram: ' + e));
+
     HawkCatcher.send(new Error('[Billing / Check] All checks passed successfully'), body as any);
 
     res.json({
@@ -720,9 +736,9 @@ export default class CloudPaymentsWebhooks {
    *
    * @param req - request with necessary data
    */
-  private async getDataFromRequest(req: express.Request): Promise<PlanProlongationData> {
+  private async getDataFromRequest(req: express.Request): Promise<PaymentData> {
     const context = req.context;
-    const body: CheckRequest = req.body;
+    const body: CheckRequest | PayRequest | FailRequest = req.body;
 
     /**
      * If Data is not presented in body means there is a recurring payment
@@ -752,6 +768,7 @@ export default class CloudPaymentsWebhooks {
         tariffPlanId: workspace.tariffPlanId.toString(),
         userId,
         shouldSaveCard: false,
+        isCardLinkOperation: false
       };
     }
 

src/billing/types/composePaymentPayload.ts

@@ -0,0 +1,22 @@
+export interface ComposePaymentPayload {
+  /**
+   * Workspace Identifier
+   */
+  workspaceId: string;
+  /**
+   * Id of the user making the payment
+   */
+  userId: string;
+  /**
+   * Workspace current plan id or plan id to change
+   */
+  tariffPlanId: string;
+  /**
+   * If true, we will save user card
+   */
+  shouldSaveCard: 'true' | 'false';
+  /**
+   * True if this is card linking operation – charging minimal amount of money to validate card info
+   */
+  isCardLinkOperation: 'true' | 'false';
+}

src/billing/types/paymentData.ts

@@ -40,4 +40,24 @@ export interface PaymentData {
    * Data for Cloudpayments needs
    */
   cloudPayments?: CloudPaymentsSettings;
+  /**
+   * Workspace Identifier
+   */
+  workspaceId: string;
+  /**
+   * Id of the user making the payment
+   */
+  userId: string;
+  /**
+   * Workspace current plan id or plan id to change
+   */
+  tariffPlanId: string;
+  /**
+   * If true, we will save user card
+   */
+  shouldSaveCard: boolean;
+  /**
+   * True if this is card linking operation – charging minimal amount of money to validate card info
+   */
+  isCardLinkOperation: boolean;
 }

src/utils/checksumService.ts

@@ -1,6 +1,29 @@
 import { PlanProlongationPayload } from '@hawk.so/types';
 import jwt, { Secret } from 'jsonwebtoken';
 
+interface ChecksumData {
+  /**
+   * Workspace Identifier
+   */
+  workspaceId: string;
+  /**
+   * Id of the user making the payment
+   */
+  userId: string;
+  /**
+   * Workspace current plan id or plan id to change
+   */
+  tariffPlanId: string;
+  /**
+   * If true, we will save user card
+   */
+  shouldSaveCard: boolean;
+  /**
+   * True if this is card linking operation – charging minimal amount of money to validate card info
+   */
+  isCardLinkOperation: boolean;
+}
+
 /**
  * Helper class for working with checksums
  */
@@ -10,7 +33,7 @@ class ChecksumService {
    *
    * @param data - data for processing billing request
    */
-  public async generateChecksum(data: PlanProlongationPayload): Promise<string> {
+  public async generateChecksum(data: ChecksumData): Promise<string> {
     return jwt.sign(
       data,
       process.env.JWT_SECRET_BILLING_CHECKSUM as Secret,
@@ -23,19 +46,20 @@ class ChecksumService {
    *
    * @param checksum - checksum to parse
    */
-  public parseAndVerifyChecksum(checksum: string): PlanProlongationPayload {
-    const payload = jwt.verify(checksum, process.env.JWT_SECRET_BILLING_CHECKSUM as Secret) as PlanProlongationPayload;
+  public parseAndVerifyChecksum(checksum: string): ChecksumData {
+    const payload = jwt.verify(checksum, process.env.JWT_SECRET_BILLING_CHECKSUM as Secret) as ChecksumData;
 
     /**
      * Filter unnecessary fields from JWT payload (e.g. "iat")
      */
-    const { tariffPlanId, workspaceId, userId, shouldSaveCard } = payload;
+    const { tariffPlanId, workspaceId, userId, shouldSaveCard, isCardLinkOperation } = payload;
 
     return {
       tariffPlanId,
       workspaceId,
       userId,
       shouldSaveCard,
+      isCardLinkOperation
     };
   }
 }