prospay-sdk 1.0.0

package/src/transaction/transaction.service.ts

@@ -0,0 +1,261 @@
+import { Injectable } from '@nestjs/common';
+import { HttpService } from '@nestjs/axios';
+import { lastValueFrom } from 'rxjs';
+
+export interface TransactionChargeBreakup {
+  head: string;
+  amount: number;
+  appliedOn: string[];
+  tags: string[];
+}
+
+export interface TransactionChargeMetadata {
+  key: string;
+  value: string;
+}
+
+export interface TransactionCharge {
+  head: string;
+  amount: number;
+  hsnOrSac: string;
+  isBillable: boolean;
+  absorbedBy: string;
+  transactionType: string;
+  /**
+   * ISO datetime string when the charge was applied.
+   * Optional for create transaction, required for add-charges use case.
+   */
+  chargedAt?: string;
+  breakup?: TransactionChargeBreakup[];
+  metadata?: TransactionChargeMetadata[];
+}
+
+export interface CreateTransactionDto {
+  customerId: string;
+  entityType: string; // e.g. "order"
+  referenceId: string;
+  currency: string; // e.g. "INR"
+  vertical: string; // e.g. "customer"
+  charges: TransactionCharge[];
+}
+
+export interface AddChargesToTransactionDto {
+  charges: TransactionCharge[];
+}
+
+export interface TransactionDateRangeFilter {
+  start: string; // ISO datetime
+  end: string;   // ISO datetime
+}
+
+export interface TransactionSearchFilters {
+  customerIds?: string[];
+  transactionDateRange?: TransactionDateRangeFilter;
+}
+
+export interface SearchTransactionsDto {
+  page: number;
+  limit: number;
+  transactionFilters: TransactionSearchFilters;
+}
+
+export interface ChargeSummaryParams {
+  startDate: string; // YYYY-MM-DD
+  endDate: string;   // YYYY-MM-DD
+}
+
+export interface ProspayCreateTransactionSuccessResponse {
+  success: true;
+  requestId: string;
+  path: string;
+  timestamp: string;
+  data: {
+    transactionId: string;
+    summary: {
+      transactionAmount: number;
+      billableAmount: number;
+      totalCreditAmount: number;
+      totalDebitAmount: number;
+    };
+  };
+}
+
+export interface ProspayCreateTransactionErrorResponse {
+  success: false;
+  requestId: string;
+  path: string;
+  timestamp: string;
+  error: {
+    code: string; // e.g. "CONFLICT"
+    errors: {
+      message: string;
+      field: string;
+      value: string;
+    }[];
+  };
+}
+
+export interface ProspayAddChargesSuccessResponse {
+  success: true;
+  requestId: string;
+  path: string;
+  timestamp: string;
+  data: {
+    transactionId: string;
+    addedChargesSummary: {
+      transactionAmount: number;
+      billableAmount: number;
+      totalCreditAmount: number;
+      totalDebitAmount: number;
+    };
+    transactionSummary: {
+      transactionAmount: number;
+      billableAmount: number;
+      totalCreditAmount: number;
+      totalDebitAmount: number;
+    };
+  };
+}
+
+export interface ProspaySearchTransactionsResponse {
+  success: true;
+  requestId: string;
+  path: string;
+  timestamp: string;
+  data: {
+    items: any[]; // structure not provided yet
+    pagination: {
+      total: number;
+      page: number;
+      limit: number;
+      totalPages: number;
+    };
+  };
+}
+
+export interface ProspayChargeSummaryItem {
+  chargeHead: string;
+  hsnOrSac: string;
+  vertical: string;
+  taxableAmount: number;
+  cgstRate: number;
+  cgst: number;
+  sgstRate: number;
+  sgst: number;
+  igstRate: number;
+  igst: number;
+  totalTaxRate: number;
+  totalTax: number;
+  netAmount: number;
+}
+
+export interface ProspayChargeSummaryResponse {
+  success: true;
+  requestId: string;
+  path: string;
+  timestamp: string;
+  data: ProspayChargeSummaryItem[];
+}
+
+@Injectable()
+export class ProspayTransactionService {
+  constructor(private readonly http: HttpService) {}
+
+  /**
+   * Create a transaction for an order.
+   * Maps to:
+   *   POST /uts/api/transactions
+   */
+  async createTransaction(
+    authToken: string,
+    payload: CreateTransactionDto,
+  ): Promise<ProspayCreateTransactionSuccessResponse> {
+    const response$ = this.http.post(
+      '/uts/api/transactions',
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Add charges to an existing transaction by transactionId.
+   * Maps to:
+   *   POST /uts/api/transactions/{transactionId}/charges
+   */
+  async addChargesToTransaction(
+    authToken: string,
+    transactionId: string,
+    payload: AddChargesToTransactionDto,
+  ): Promise<ProspayAddChargesSuccessResponse> {
+    const response$ = this.http.post(
+      `/uts/api/transactions/${transactionId}/charges`,
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Search transactions with filters (customerIds, date range, etc.).
+   * Maps to:
+   *   POST /uts/api/transactions/search
+   */
+  async searchTransactions(
+    authToken: string,
+    payload: SearchTransactionsDto,
+  ): Promise<ProspaySearchTransactionsResponse> {
+    const response$ = this.http.post(
+      '/uts/api/transactions/search',
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Get charge summary for a date range.
+   * Maps to:
+   *   GET /uts/api/transactions/charge-summary/?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD
+   */
+  async getChargeSummary(
+    authToken: string,
+    params: ChargeSummaryParams,
+  ): Promise<ProspayChargeSummaryResponse> {
+    const response$ = this.http.get(
+      '/uts/api/transactions/charge-summary/',
+      {
+        params,
+        headers: {
+          Authorization: authToken,
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+}
+
+

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2019",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "types": ["node"],
+    "lib": ["es2019", "dom"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}
+
+