prospay-sdk 1.0.0

package/src/customer/customer.service.ts

@@ -0,0 +1,325 @@
+import { Injectable } from '@nestjs/common';
+import { HttpService } from '@nestjs/axios';
+import { lastValueFrom } from 'rxjs';
+
+export interface CreateCustomerDto {
+  productId: string;
+  productCustomerId: string;
+  orgName: string;
+  customerType: string;
+  contacts: {
+    email: string;
+    mobileNumber: string;
+  };
+}
+
+export interface UpdateCustomerDto {
+  productId?: string;
+  creditPeriodInDays?: string;
+  uin?: string;
+  preferences?: {
+    isMainOrg?: boolean;
+    mainOrgCustomerId?: string;
+    shareWallet?: boolean;
+    customerIdForWallet?: string;
+    shareKYC?: boolean;
+    customerIdForKYC?: string;
+    paymentType?: string;
+  };
+  isDeliveryAllowed?: boolean;
+  billingType?: string;
+  invoiceGenerationPeriod?: string;
+  CIN?: string;
+  status?: string;
+  creditlimit?: number;
+  contacts?: {
+    email?: string;
+    mobileNumber?: string;
+  };
+  industryType?: string;
+  KYC?: {
+    businessType?: string;
+    isGSTRegistered?: boolean;
+    GST?: string;
+    customerConsent?: boolean;
+  };
+  address?: {
+    line1?: string;
+    line2?: string;
+    city?: string;
+    state?: string;
+    pincode?: string;
+    stateCode?: string;
+  };
+}
+
+export interface UpdateCustomerStatusDto {
+  productId: string;
+  status: string;
+}
+
+export interface ProspayCreateCustomerResponse {
+  status: number;
+  message: string;
+  data: {
+    customerId: string;
+    customerData: any;
+    virtualAccountNo: string | null;
+    uin: string | null;
+    qrString: string | null;
+    isDeliveryAllowed: boolean;
+    creditPeriodInDays: string;
+  };
+}
+
+export interface ProspayErrorResponse {
+  message: string;
+}
+
+export interface ProspayUpdateCustomerResponse {
+  status: number;
+  message: string;
+  data: {
+    uin: string;
+    creditPeriodInDays: string;
+    customerId: string;
+    customerData: any;
+    kycData: any;
+    creditLimit: {
+      walletId: string;
+      oldCreditLimit: number;
+      newCreditLimit: number;
+      newAvailableBalance: number;
+      currency: string;
+      updatedAt: string;
+    };
+  };
+}
+
+export interface ProspayUpdateCustomerStatusResponse {
+  status: number;
+  message: string;
+  data: {
+    uin: string;
+    creditPeriodInDays: number;
+    customerId: string;
+    customerData: any;
+  };
+}
+
+export interface ProspayGetCustomerByIdResponseItem {
+  onBoardedDate: string;
+  kycStatus: string | null;
+  virtualAccountNo: {
+    customer: any;
+  };
+  qrString: string | null;
+  creditPeriodInDays: number;
+  productId: string;
+  productCustomerId: string;
+  customerId: string;
+  isMainOrg: boolean;
+  mainOrgCustomerId: string | null;
+  businessType: string | null;
+  payment_type: string;
+  billingType: string;
+  productOrgId: string;
+  invoiceGenerationPeriod: string;
+  cin: string | null;
+  uin: string | null;
+  orgId: string;
+  tenantId: string;
+  isGstRegistered: boolean | null;
+  name: string;
+  industryType: string | null;
+  contact: {
+    email: string;
+    mobileNumber: string;
+  };
+  customerType: string[];
+  isDeliveryAllowed: boolean;
+  status: string;
+  productName: string;
+  orgName: string;
+  businessSegment: string;
+  bankDetails: {
+    bankName: string | null;
+    ifscCode: string | null;
+    accountNo: string | null;
+    accountHolderName: string | null;
+    account_type: string | null;
+    UPI_id: string | null;
+    bankBranch: string | null;
+  };
+  aadhar: string | null;
+  businessPAN: string | null;
+  signatoryPAN: string | null;
+  GST: string | null;
+  tan: string | null;
+  DL: string | null;
+  signatoryPanfromGST: string | null;
+  businessPanfromGST: string | null;
+  signatoryPanfromAadhar: string | null;
+  address: {
+    addressLine1: string | null;
+    addressLine2: string | null;
+    state: string | null;
+    pinCode: string | null;
+    city: string | null;
+    stateCode: string | null;
+  };
+  hoDetails: any;
+  kyc: any;
+  creditlimit: number;
+  creditbalance: number;
+}
+
+export interface ProspayGetCustomerByIdResponse {
+  status: number;
+  message: string;
+  data: ProspayGetCustomerByIdResponseItem[];
+  cached: boolean;
+}
+
+export interface SearchCustomersParams {
+  filter?: string; // e.g. "all"
+  mobileNumber?: string;
+  productCustomerId?: string;
+  customerType?: string;
+}
+
+export interface ProspaySearchCustomersResponse {
+  status: number;
+  message: string;
+  data: any; // structure not provided; keeping broad until sample is shared
+}
+
+@Injectable()
+export class ProspayCustomerService {
+  constructor(private readonly http: HttpService) {}
+
+  /**
+   * Create a new customer.
+   * Maps to:
+   *   POST /customer/api/v3.0/customers
+   */
+  async createCustomer(
+    authToken: string,
+    payload: CreateCustomerDto,
+  ): Promise<ProspayCreateCustomerResponse> {
+    const response$ = this.http.post(
+      '/customer/api/v3.0/customers',
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Update an existing customer by Prospay customer ID.
+   * Maps to:
+   *   PATCH /customer/api/v3.0/customers/{customerId}/
+   */
+  async updateCustomer(
+    authToken: string,
+    customerId: string,
+    payload: UpdateCustomerDto,
+  ): Promise<ProspayUpdateCustomerResponse> {
+    const response$ = this.http.patch(
+      `/customer/api/v3.0/customers/${customerId}/`,
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Update customer status (enabled/disabled).
+   * Maps to:
+   *   PATCH /customer/api/v3.0/customers/{customerId}/
+   * with body:
+   *   { "productId": "...", "status": "enabled" | "disabled" | ... }
+   */
+  async updateCustomerStatus(
+    authToken: string,
+    customerId: string,
+    payload: UpdateCustomerStatusDto,
+  ): Promise<ProspayUpdateCustomerStatusResponse> {
+    const response$ = this.http.patch(
+      `/customer/api/v3.0/customers/${customerId}/`,
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Get customer by Prospay customer ID.
+   * Maps to:
+   *   GET /customer/api/v3.0/customers/{customerId}?filter=all
+   */
+  async getCustomerById(
+    authToken: string,
+    customerId: string,
+  ): Promise<ProspayGetCustomerByIdResponse> {
+    const response$ = this.http.get(
+      `/customer/api/v3.0/customers/${customerId}`,
+      {
+        params: { filter: 'all' },
+        headers: {
+          Authorization: authToken,
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Search customers using query params.
+   * Example params: filter=all, mobileNumber=..., productCustomerId=..., customerType=...
+   * Maps to:
+   *   GET /customer/api/v3.0/customers/search
+   */
+  async searchCustomers(
+    authToken: string,
+    params: SearchCustomersParams,
+  ): Promise<ProspaySearchCustomersResponse> {
+    const response$ = this.http.get(
+      '/customer/api/v3.0/customers/search',
+      {
+        params,
+        headers: {
+          Authorization: authToken,
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+}
+
+

package/src/index.ts

@@ -0,0 +1,44 @@
+import 'reflect-metadata';
+import { Module, DynamicModule } from '@nestjs/common';
+import { HttpModule } from '@nestjs/axios';
+import { ProspayAuthService } from './auth/auth.service';
+import { ProspayCustomerService } from './customer/customer.service';
+import { ProspayTransactionService } from './transaction/transaction.service';
+import { ProspayInvoiceService } from './invoice/invoice.service';
+import { PROSPAY_SDK_OPTIONS, ProspaySdkOptions } from './sdk.config';
+
+@Module({})
+export class ProspaySdkModule {
+  static register(options: ProspaySdkOptions): DynamicModule {
+    const baseUrl = options.baseUrl ?? 'https://sandbox.prospay.tech';
+
+    return {
+      module: ProspaySdkModule,
+      imports: [
+        HttpModule.register({
+          baseURL: baseUrl,
+          timeout: 5000,
+        }),
+      ],
+      providers: [
+        {
+          provide: PROSPAY_SDK_OPTIONS,
+          useValue: options,
+        },
+        ProspayAuthService,
+        ProspayCustomerService,
+        ProspayTransactionService,
+        ProspayInvoiceService,
+      ],
+      exports: [ProspayAuthService, ProspayCustomerService, ProspayTransactionService, ProspayInvoiceService],
+    };
+  }
+}
+
+export * from '@nestjs/common';
+export * from './auth/auth.service';
+export * from './customer/customer.service';
+export * from './transaction/transaction.service';
+export * from './invoice/invoice.service';
+export * from './sdk.config';
+

package/src/invoice/invoice.service.ts

@@ -0,0 +1,161 @@
+import { Injectable } from '@nestjs/common';
+import { HttpService } from '@nestjs/axios';
+import { lastValueFrom } from 'rxjs';
+
+export interface GenerateBulkInvoiceDto {
+  templateName: string;
+  productId: string;
+  startDate: string; // YYYY-MM-DD
+  endDate: string;   // YYYY-MM-DD
+  buyer_customerId: string;
+  seller_customerId: string;
+  due_date: string; // YYYY-MM-DD
+  invoice_no: string;
+  invoice_date: string; // e.g. DD-MM-YYYY
+  invoice_period: string;
+}
+
+export interface ProspayGenerateInvoiceResponse {
+  status: string; // e.g. "ok"
+  message: string; // e.g. "Process initiated for generating invoice"
+  refId: string;
+}
+
+export interface BulkInvoiceItem {
+  endDate: string;
+  startDate: string;
+  buyer_customerId: string;
+  seller_customerId: string;
+  productId: string;
+  due_date: string;
+  invoice_no: string;
+  invoice_date: string;
+  invoice_period: string;
+}
+
+export interface GenerateBulkInvoiceBatchDto {
+  templateName: string;
+  data: BulkInvoiceItem[];
+}
+
+export interface GenerateInvoiceDto {
+  templateName: string;
+  productId: string;
+  startDate: string; // YYYY-MM-DD
+  endDate: string;   // YYYY-MM-DD
+  buyer_customerId: string;
+  seller_customerId: string;
+  due_date: string; // YYYY-MM-DD
+  invoice_no: string;
+  invoice_date: string; // e.g. DD-MM-YYYY
+  invoice_period: string;
+}
+
+export interface InvoiceStatusStatistics {
+  total: number;
+  success: number;
+  failed: number;
+  processing: number;
+}
+
+export interface InvoiceStatusItem {
+  invoiceId: string | null;
+  status: string;
+  createdAt: string;
+  customerId: string;
+  pdfUrl?: string;
+  completedAt?: string;
+  error?: string;
+  errorDetails?: any;
+}
+
+export interface ProspayInvoiceStatusResponse {
+  refId: string;
+  overallStatus: string;
+  templateName: string | null;
+  productId: string;
+  statistics: InvoiceStatusStatistics;
+  invoices: InvoiceStatusItem[];
+}
+
+@Injectable()
+export class ProspayInvoiceService {
+  constructor(private readonly http: HttpService) {}
+
+  /**
+   * Generate bulk invoice.
+   * Maps to:
+   *   POST /invoices/api/v2.0/generateBulkInvoice
+   */
+  async generateBulkInvoice(
+    authToken: string,
+    payload: GenerateBulkInvoiceDto,
+    callbackUrl?: string,
+  ): Promise<ProspayGenerateInvoiceResponse> {
+    const response$ = this.http.post(
+      '/invoices/api/v2.0/generateBulkInvoice',
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+          ...(callbackUrl ? { 'callback-url': callbackUrl } : {}),
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Generate a single invoice.
+   * Maps to:
+   *   POST /invoices/api/v2.0/generateInvoice
+   */
+  async generateInvoice(
+    authToken: string,
+    payload: GenerateInvoiceDto,
+    callbackUrl?: string,
+  ): Promise<ProspayGenerateInvoiceResponse> {
+    const response$ = this.http.post(
+      '/invoices/api/v2.0/generateInvoice',
+      payload,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+          ...(callbackUrl ? { 'callback-url': callbackUrl } : {}),
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+
+  /**
+   * Get invoice generation status by refId.
+   * Maps to:
+   *   GET /invoices/api/v2.0/invoice-status/{refId}
+   */
+  async getInvoiceStatus(
+    authToken: string,
+    refId: string,
+  ): Promise<ProspayInvoiceStatusResponse> {
+    const response$ = this.http.get(
+      `/invoices/api/v2.0/invoice-status/${refId}`,
+      {
+        headers: {
+          Authorization: authToken,
+          'Content-Type': 'application/json',
+        },
+      },
+    );
+
+    const response = await lastValueFrom(response$);
+    return response.data;
+  }
+}
+
+

package/src/sdk.config.ts

@@ -0,0 +1,21 @@
+export const PROSPAY_SDK_OPTIONS = 'PROSPAY_SDK_OPTIONS';
+
+export interface ProspaySdkOptions {
+  /**
+   * Prospay product identifier (used as resourceId header and in hash).
+   */
+  productId: string;
+
+  /**
+   * Prospay product API key (used only to generate the bcrypt hash).
+   */
+  productApiKey: string;
+
+  /**
+   * Optional base URL; defaults to Prospay sandbox.
+   * Example: https://sandbox.prospay.tech
+   */
+  baseUrl?: string;
+}
+
+