Merge pull request #52 from topcoder-platform/PM-1221_update-wallet-details

PM-1221 - update wallet details endpoint

Author: vas3a

src/api/wallet/wallet.controller.ts

@@ -10,7 +10,10 @@ import { Role } from 'src/core/auth/auth.constants';
 import { Roles, User } from 'src/core/auth/decorators';
 import { UserInfo } from 'src/dto/user.type';
 import { ResponseDto, ResponseStatusType } from 'src/dto/api-response.dto';
-import { WalletDetailDto } from 'src/dto/wallet.dto';
+import {
+  WalletDetailDto,
+  walletDetailResponseExample,
+} from 'src/dto/wallet.dto';
 
 import { WalletService } from './wallet.service';
 
@@ -30,6 +33,10 @@ export class WalletController {
     status: 200,
     description: 'Get wallet detail successfully.',
     type: ResponseDto<WalletDetailDto>,
+    example: {
+      data: walletDetailResponseExample,
+      status: 'success',
+    },
   })
   @HttpCode(HttpStatus.OK)
   async getWallet(

src/api/wallet/wallet.service.ts

@@ -7,6 +7,7 @@ import { ResponseDto } from 'src/dto/api-response.dto';
 import { WinningsType } from 'src/dto/winning.dto';
 import { TaxFormRepository } from '../repository/taxForm.repo';
 import { PaymentMethodRepository } from '../repository/paymentMethod.repo';
+import { TrolleyService } from 'src/shared/global/trolley.service';
 
 /**
  * The winning service.
@@ -23,8 +24,23 @@ export class WalletService {
     private readonly prisma: PrismaService,
     private readonly taxFormRepo: TaxFormRepository,
     private readonly paymentMethodRepo: PaymentMethodRepository,
+    private readonly trolleyService: TrolleyService,
   ) {}
 
+  async getPaymentTaxDetails(userId: string) {
+    const recipient = await this.prisma.trolley_recipient.findFirst({
+      where: { user_id: userId },
+    });
+
+    if (!recipient) {
+      return;
+    }
+
+    return await this.trolleyService.getRecipientTaxDetails(
+      recipient.trolley_id,
+    );
+  }
+
   /**
    * Get wallet detail.
    * @param userId the request userId
@@ -43,7 +59,9 @@ export class WalletService {
         await this.paymentMethodRepo.getConnectedPaymentMethod(userId),
       );
 
-      const winningTotals: WalletDetailDto = {
+      const taxWithholdingDetails = await this.getPaymentTaxDetails(userId);
+
+      result.data = {
         account: {
           balances: [
             {
@@ -68,9 +86,8 @@ export class WalletService {
         taxForm: {
           isSetupComplete: hasActiveTaxForm,
         },
+        ...(taxWithholdingDetails ?? {}),
       };
-
-      result.data = winningTotals;
     } catch (error) {
       this.logger.error('Getting winnings audit failed', error);
       const message = 'Searching winnings failed. ' + error;

src/dto/wallet.dto.ts

@@ -1,3 +1,24 @@
+export const walletDetailResponseExample = {
+  account: {
+    balances: [
+      {
+        type: 'PAYMENT',
+        amount: 1000,
+        unit: 'currency',
+      },
+    ],
+  },
+  withdrawalMethod: {
+    isSetupComplete: true,
+  },
+  taxForm: {
+    isSetupComplete: true,
+  },
+  estimatedFees: '0',
+  primaryCurrency: 'USD',
+  taxWithholdingPercentage: '0',
+};
+
 export class WalletDetailDto {
   account: {
     balances: {
@@ -12,4 +33,7 @@ export class WalletDetailDto {
   taxForm: {
     isSetupComplete: boolean;
   };
+  primaryCurrency?: string | null;
+  estimatedFees?: string | null;
+  taxWithholdingPercentage?: string | null;
 }

src/shared/global/trolley.service.ts

@@ -1,13 +1,20 @@
 import url from 'url';
 import crypto from 'crypto';
 import trolley from 'trolleyhq';
+import { pick } from 'lodash';
 import { Injectable, Logger } from '@nestjs/common';
 import { ENV_CONFIG } from 'src/config';
 
 const TROLLEY_ACCESS_KEY = ENV_CONFIG.TROLLEY_ACCESS_KEY;
 const TROLLEY_SECRET_KEY = ENV_CONFIG.TROLLEY_SECRET_KEY;
 const TROLLEY_WIDGET_BASE_URL = ENV_CONFIG.TROLLEY_WIDGET_BASE_URL;
 
+export interface RecipientTaxDetails {
+  primaryCurrency: string | null;
+  estimatedFees: string | null;
+  taxWithholdingPercentage: string | null;
+}
+
 const client = trolley({
   key: TROLLEY_ACCESS_KEY,
   secret: TROLLEY_SECRET_KEY,
@@ -167,4 +174,22 @@ export class TrolleyService {
       throw new Error('Failed to process trolley payment batch!');
     }
   }
+
+  async getRecipientTaxDetails(
+    recipientId: string,
+  ): Promise<RecipientTaxDetails | void> {
+    try {
+      const recipient = await this.client.recipient.find(recipientId);
+      return pick(recipient, [
+        'estimatedFees',
+        'primaryCurrency',
+        'taxWithholdingPercentage',
+      ]) as RecipientTaxDetails;
+    } catch (error) {
+      this.logger.error(
+        'Failed to load recipient tax details from trolley!',
+        error,
+      );
+    }
+  }
 }