prospay-sdk 1.1.0 → 1.1.2

package/dist/transaction/transaction.service.d.ts

@@ -25,6 +25,9 @@ export interface CreateTransactionDto {
     entityType: string;
     referenceId: string;
     currency: string;
+    vertical?: string;
+    fromStateCode?: string;
+    toStateCode?: string;
     charges: TransactionCharge[];
 }
 export interface AddChargesToTransactionDto {

package/dist/transaction/transaction.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.service.js","sourceRoot":"","sources":["../../src/transaction/transaction.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,yCAA4C;AAC5C,+BAAqC;AA8J9B,IAAM,yBAAyB,GAA/B,MAAM,yBAAyB;IACpC,YAA6B,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;IAAG,CAAC;IAOlD,KAAK,CAAC,iBAAiB,CACrB,SAAiB,EACjB,OAA6B;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9B,uBAAuB,EACvB,OAAO,EACP;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;gBACxB,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAOD,KAAK,CAAC,uBAAuB,CAC3B,SAAiB,EACjB,aAAqB,EACrB,OAAmC;QAEnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9B,yBAAyB,aAAa,UAAU,EAChD,OAAO,EACP;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;gBACxB,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAOD,KAAK,CAAC,kBAAkB,CACtB,SAAiB,EACjB,OAA8B;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9B,8BAA8B,EAC9B,OAAO,EACP;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;gBACxB,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAOD,KAAK,CAAC,gBAAgB,CACpB,SAAiB,EACjB,MAA2B;QAE3B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAC7B,uCAAuC,EACvC;YACE,MAAM;YACN,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;aACzB;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF,CAAA;AAlGY,8DAAyB;oCAAzB,yBAAyB;IADrC,IAAA,mBAAU,GAAE;qCAEwB,mBAAW;GADnC,yBAAyB,CAkGrC"}
+{"version":3,"file":"transaction.service.js","sourceRoot":"","sources":["../../src/transaction/transaction.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,yCAA4C;AAC5C,+BAAqC;AAgK9B,IAAM,yBAAyB,GAA/B,MAAM,yBAAyB;IACpC,YAA6B,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;IAAG,CAAC;IAOlD,KAAK,CAAC,iBAAiB,CACrB,SAAiB,EACjB,OAA6B;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9B,uBAAuB,EACvB,OAAO,EACP;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;gBACxB,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAOD,KAAK,CAAC,uBAAuB,CAC3B,SAAiB,EACjB,aAAqB,EACrB,OAAmC;QAEnC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9B,yBAAyB,aAAa,UAAU,EAChD,OAAO,EACP;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;gBACxB,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAOD,KAAK,CAAC,kBAAkB,CACtB,SAAiB,EACjB,OAA8B;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9B,8BAA8B,EAC9B,OAAO,EACP;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;gBACxB,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAOD,KAAK,CAAC,gBAAgB,CACpB,SAAiB,EACjB,MAA2B;QAE3B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAC7B,uCAAuC,EACvC;YACE,MAAM;YACN,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS;aACzB;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,SAAS,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF,CAAA;AAlGY,8DAAyB;oCAAzB,yBAAyB;IADrC,IAAA,mBAAU,GAAE;qCAEwB,mBAAW;GADnC,yBAAyB,CAkGrC"}

package/manual.txt

@@ -1,73 +1,58 @@
-ProspayAuthService
-  - authenticate(): POST {baseUrl}/auth/api/v1.0/authenz/token?action=verify
-      Inputs: headers => timestamp (epoch seconds), resourceId (productId), keyhash (bcrypt of `${timestamp}.${productId}.${productApiKey}`); no body.
-      Success: `{ status, message?, token?, ... }` (auth token payload). Base URL defaults to https://sandbox.prospay.tech.
-
-ProspayCustomerService
-  - createCustomer(authToken, payload): POST /customer/api/v3.0/customers
-      Inputs (body): productId, productCustomerId, orgName, customerType, contacts { email, mobileNumber }.
-      Success: `{ status, message, data: { customerId, customerData, virtualAccountNo, uin, qrString, isDeliveryAllowed, creditPeriodInDays } }`.
-
-  - updateCustomer(authToken, customerId, payload): PATCH /customer/api/v3.0/customers/{customerId}/
-      Inputs (body): any subset of creditPeriodInDays, uin, preferences { isMainOrg, mainOrgCustomerId, shareWallet, customerIdForWallet, shareKYC, customerIdForKYC, paymentType }, isDeliveryAllowed, billingType, invoiceGenerationPeriod, CIN, status, creditlimit, contacts { email, mobileNumber }, industryType, KYC { businessType, isGSTRegistered, GST, customerConsent }, address { line1, line2, city, state, pincode, stateCode }, productId.
-      Success: `{ status, message, data: { uin, creditPeriodInDays, customerId, customerData, kycData, creditLimit: { walletId, oldCreditLimit, newCreditLimit, newAvailableBalance, currency, updatedAt } } }`.
-      
-  - updateCustomerStatus(authToken, customerId, payload): PATCH /customer/api/v3.0/customers/{customerId}/
-      Inputs (body): productId, status.
-      Success: `{ status, message, data: { uin, creditPeriodInDays, customerId, customerData } }`.
-
-  - getCustomerById(authToken, customerId): GET /customer/api/v3.0/customers/{customerId}?filter=all
-      Inputs: headers => Authorization; query => filter=all.
-      Success: `{ status, message, data: [customerProfile...], cached }` (profiles include contact, KYC, credit, bank, address, flags).
-
-  - searchCustomers(authToken, params): GET /customer/api/v3.0/customers/search
-      Inputs (query): filter?, mobileNumber?, productCustomerId?, customerType?; headers => Authorization.
-      Success: `{ status, message, data }` (structure depends on search result).
-
-ProspayInvoiceService
-  - generateBulkInvoice(authToken, payload, callbackUrl?): POST /invoices/api/v2.0/generateBulkInvoice
-      Inputs (body): templateName, productId, startDate (YYYY-MM-DD), endDate (YYYY-MM-DD), buyer_customerId, seller_customerId, due_date (YYYY-MM-DD), invoice_no, invoice_date (DD-MM-YYYY), invoice_period; headers => Authorization, Content-Type, optional callback-url.
-      Success: `{ status: "ok", message: "Process initiated for generating invoice", refId }`.
-
-  - generateInvoice(authToken, payload, callbackUrl?): POST /invoices/api/v2.0/generateInvoice
-      Inputs (body): templateName, productId, startDate (YYYY-MM-DD), endDate (YYYY-MM-DD), buyer_customerId, seller_customerId, due_date (YYYY-MM-DD), invoice_no, invoice_date (DD-MM-YYYY), invoice_period; headers => Authorization, Content-Type, optional callback-url.
-      Success: `{ status: "ok", message: "Process initiated for generating invoice", refId }`.
-
-  - getInvoiceStatus(authToken, refId): GET /invoices/api/v2.0/invoice-status/{refId}
-      Inputs: path => refId; headers => Authorization, Content-Type.
-      Success: `{ refId, overallStatus, templateName, productId, statistics: { total, success, failed, processing }, invoices: [{ invoiceId, status, createdAt, customerId, pdfUrl?, completedAt?, error?, errorDetails? }] }`.
-
-ProspayTransactionService
-  - createTransaction(authToken, payload): POST /uts/api/transactions
-      Inputs (body): customerId, entityType (e.g., "order"), referenceId, currency (e.g., "INR"), vertical (e.g., "customer"), charges: [{ head, amount, hsnOrSac, isBillable, absorbedBy, transactionType, chargedAt?, appliedOn?, tags?, breakup?, metadata? }].
-      Success: `{ success: true, requestId, path, timestamp, data: { transactionId, summary: { transactionAmount, billableAmount, totalCreditAmount, totalDebitAmount } } }`.
-
-  - addChargesToTransaction(authToken, transactionId, payload): POST /uts/api/transactions/{transactionId}/charges
-      Inputs (body): charges: [{ head, amount, hsnOrSac, isBillable, absorbedBy, transactionType, chargedAt?, appliedOn?, tags?, breakup?, metadata? }]; path => transactionId.
-      Success: `{ success: true, requestId, path, timestamp, data: { transactionId, addedChargesSummary: { transactionAmount, billableAmount, totalCreditAmount, totalDebitAmount }, transactionSummary: { transactionAmount, billableAmount, totalCreditAmount, totalDebitAmount } } }`.
-
-  - searchTransactions(authToken, payload): POST /uts/api/transactions/search
-      Inputs (body): page, limit, transactionFilters { customerIds?, transactionDateRange? { start, end } }.
-      Success: `{ success: true, requestId, path, timestamp, data: { items: [...], pagination: { total, page, limit, totalPages } } }`.
-
-  - getChargeSummary(authToken, params): GET /uts/api/transactions/charge-summary/
-      Inputs (query): startDate (YYYY-MM-DD), endDate (YYYY-MM-DD); headers => Authorization.
-      Success: `{ success: true, requestId, path, timestamp, data: [{ chargeHead, hsnOrSac, vertical, taxableAmount, cgstRate, cgst, sgstRate, sgst, igstRate, igst, totalTaxRate, totalTax, netAmount }, ...] }`.
-
-ProspayPaymentService
-  - generateQr(authToken, payload): POST /payments/api/v2.0/QR
-      Inputs (body): customerId, amountInPaise, productId, productOrderId, callbackUrl, reason?, contacts { name?, email?, mobileNumber? }.
-      Success: `{ success, orderId, txnId, qrCode, providerName }`.
-
-  - generatePaymentLink(authToken, payload): POST /payments/api/v2.0/paymentLink
-      Inputs (body): customerId, amountInPaise, productId, productOrderId, callbackUrl, reason?, contacts { name?, email?, mobileNumber? }, orderInformation? { itemName, price, quantity }.
-      Success: `{ status, message, data }` (data may include payment link metadata).
-      
-  - refundPayment(authToken, productOrderId, payload): POST /payments/api/v2.0/payment/{productOrderId}/refund
-      Inputs (path): productOrderId; body: productId, customerId, originalProductOrderId, productRefundId, amountWithGSTInPaise, amountWithoutGSTInPaise, reason?.
-      Success: `{ status, message, data }`.
-
-  - getPaymentStatus(authToken, productOrderId): GET /payments/api/v2.0/payment/{productOrderId}/status
-      Inputs: path => productOrderId; headers => Authorization.
-      Success: `{ status, message, data: { paymentTxnId, productOrderId, paymemtOrderId, payment_status, paymentTxnType, paymentAmount, paymentDate } }`.
-      Errors: e.g. `{ message: "orderId not found" }`.
+Prospay SDK Manual
+
+Purpose
+- Provide a simple NestJS-based client for Prospay APIs: authentication, customers, invoices, transactions, and payments (QR, payment link, refund, status).
+- Wrap HTTP calls with typed methods and consistent headers; default base URL is `https://sandbox.prospay.tech`.
+
+Download
+- npm: `https://www.npmjs.com/package/prospay-sdk`
+- Install: `npm install prospay-sdk`
+
+Setup
+- Import the SDK module and register with your product credentials:
+- `ProspaySdkModule.register({ productId, productApiKey, baseUrl?: 'https://sandbox.prospay.tech' })`
+- Inject services (Auth, Customer, Invoice, Transaction, Payment) in your Nest providers.
+
+Auth
+- `authenticate()`: POST `{baseUrl}/auth/api/v1.0/authenz/token?action=verify`
+- Headers: `timestamp` (epoch seconds), `resourceId` (productId), `keyhash` (bcrypt of `timestamp.productId.productApiKey`)
+- Returns auth token payload.
+
+Customers
+- `createCustomer(authToken, payload)`: POST `/customer/api/v3.0/customers`
+- `updateCustomer(authToken, customerId, payload)`: PATCH `/customer/api/v3.0/customers/{customerId}/`
+- `updateCustomerStatus(authToken, customerId, payload)`: PATCH `/customer/api/v3.0/customers/{customerId}/`
+- `getCustomerById(authToken, customerId)`: GET `/customer/api/v3.0/customers/{customerId}?filter=all`
+- `searchCustomers(authToken, params)`: GET `/customer/api/v3.0/customers/search`
+
+Invoices
+- `generateBulkInvoice(authToken, payload, callbackUrl?)`: POST `/invoices/api/v2.0/generateBulkInvoice`
+- `generateInvoice(authToken, payload, callbackUrl?)`: POST `/invoices/api/v2.0/generateInvoice`
+- `getInvoiceStatus(authToken, refId)`: GET `/invoices/api/v2.0/invoice-status/{refId}`
+- Returns `refId`, `overallStatus`, statistics, and detailed invoice items.
+
+Transactions
+- `createTransaction(authToken, payload)`: POST `/uts/api/transactions`
+- Body: `customerId`, `entityType`, `referenceId`, `currency`, `charges`, optional `fromStateCode`, optional `toStateCode`, optional `vertical`
+- `addChargesToTransaction(authToken, transactionId, payload)`: POST `/uts/api/transactions/{transactionId}/charges`
+- `searchTransactions(authToken, payload)`: POST `/uts/api/transactions/search`
+- `getChargeSummary(authToken, params)`: GET `/uts/api/transactions/charge-summary/`
+
+Payments
+- `generateQr(authToken, payload)`: POST `/payments/api/v2.0/QR`
+- Body: `customerId`, `amountInPaise`, `productId`, `productOrderId`, `callbackUrl`, optional `reason`, `contacts { name?, email?, mobileNumber? }`
+- Success: `{ success, orderId, txnId, qrCode, providerName }`
+- `generatePaymentLink(authToken, payload)`: POST `/payments/api/v2.0/paymentLink`
+- Body: `customerId`, `amountInPaise`, `productId`, `productOrderId`, `callbackUrl`, optional `reason`, `contacts`, `orderInformation { itemName, price, quantity }`
+- Success: `{ status, message, data }`
+- `refundPayment(authToken, productOrderId, payload)`: POST `/payments/api/v2.0/payment/{productOrderId}/refund`
+- Body: `productId`, `customerId`, `originalProductOrderId`, `productRefundId`, `amountWithGSTInPaise`, `amountWithoutGSTInPaise`, optional `reason`
+- Success: `{ status, message, data }`
+- `getPaymentStatus(authToken, productOrderId)`: GET `/payments/api/v2.0/payment/{productOrderId}/status`
+- Success: `{ status, message, data: { paymentTxnId, productOrderId, paymemtOrderId, payment_status, paymentTxnType, paymentAmount, paymentDate } }`
+- Errors: `{ message: "orderId not found" }`, missing token returns `{"message":"No token provided"}`
+
+Notes
+- Always set `Authorization` header with the token from `authenticate()`.
+- `amountInPaise` is an integer in paise (₹1 = 100).
+- Avoid backticks and extra spaces around JSON values in requests.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prospay-sdk",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "NestJS-based SDK for Prospay customer onboarding, order, and invoicing APIs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/transaction/transaction.service.ts

@@ -35,7 +35,9 @@ export interface CreateTransactionDto {
   entityType: string; // e.g. "order"
   referenceId: string;
   currency: string; // e.g. "INR"
-  // vertical: string; // e.g. "customer"
+  vertical?: string; // e.g. "customer"
+  fromStateCode?: string;
+  toStateCode?: string;
   charges: TransactionCharge[];
 }