node-paytmpg 6.4.6 → 7.0.1

package/README.MD

@@ -1,245 +1,195 @@
-## Node JS Payments Easy Integration
+## node-paytmpg
 
-[![NPM Publish](https://github.com/shiveshnavin/node_paytm/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/shiveshnavin/node_paytm/actions/workflows/npm-publish.yml)
-[![Node.js CI](https://github.com/shiveshnavin/node_paytm/actions/workflows/nodejs.yml/badge.svg)](https://github.com/shiveshnavin/node_paytm/actions/workflows/nodejs.yml)
+Express middleware for integrating Paytm / Razorpay / PayU / Open Money payments with built-in checkout pages and APIs.
 
-Support for : 
- - Paytm
- - RazorPay
- - Open Money
- 
-Does all the hardwork for you while integrating payments in any express app. Comes with inbuilt UI and REST APIs for lightning fast development and prototyping .
+## Install
 
-## Example 
-
-Demo : https://node-paytm.herokuapp.com/_pay/init
-
-Use any Card Details or Net Banking 
-username : test
-password : test
-
-Example App Sourcecode : https://github.com/shiveshnavin/payment-gateway-example
-
-### Requirments
-
-1. MongoDB / Firestore / SQlite
-2. Your Merchant Credentials 
-3. Express . This only works with NodeJS express server
+```bash
+npm install node-paytmpg multi-db-orm
+```
 
-You can get your paytm credentials here
-https://developer.paytm.com/docs
+## Quick start (current API)
 
+```js
+const express = require("express");
+const { FireStoreDB } = require("multi-db-orm");
+const { attachBodyParser, createPaymentMiddleware } = require("node-paytmpg");
 
+const app = express();
+const db = new FireStoreDB(require("./creds.json"));
 
-![Alt text](public/start.png "Start")
+const config = {
+  host_url: "http://127.0.0.1:5544",
+  path_prefix: "pay",
+  homepage: "/",
 
-![Alt text](public/start2.png "Start")
+  // enable one gateway
+  payu_url: "https://test.payu.in/_payment",
+  // paytm_url: 'https://securegw-stage.paytm.in',
+  // razor_url: 'https://api.razorpay.com/',
+  // open_money_url: 'https://sandbox-icp-api.bankopen.co/api',
 
-![Alt text](public/pay.png "Start")
+  MID: "YOUR_MID",
+  WEBSITE: "WEBSTAGING",
+  KEY: "YOUR_KEY",
+  SECRET: "YOUR_SECRET",
+  CHANNEL_ID: "WAP",
+  INDUSTRY_TYPE_ID: "Retail",
+};
 
-![Alt text](public/stat.png "Start")
- 
+attachBodyParser(app, config);
 
-### Install
+const paymentRouter = createPaymentMiddleware(app, config, db);
+app.use("/" + config.path_prefix, paymentRouter);
 
-```code
-npm install node-paytmpg --save
+app.listen(5544, () => {
+  console.log("Server started on 5544");
+});
 ```
 
-In your main nodejs file set configuration in express app
+## `attachBodyParser(app, config)`
 
+Use this before creating the payment middleware.
 
-### Paytm
-```code
-host_url : Host URL of your server . This will be used to redirect user after payment
-view_path : Ignore and dont change unless you know what you are doing . This is the useful in case you want to modify payment init page UI from node_paytm_pg library
-paytm_url : For Test "https://securegw-stage.paytm.in" and for Production "https://securegw.paytm.in"
-MID : Your Paytm Merchant ID
-Website : "WEBSTAGING" for Test and for Production , the website you entered while activation
-KEY : Your Unique Key from Paytm used for hashing 
-CHANNEL_ID : Know More at Paytm Docs
-INDUSTRY_TYPE_ID : Know More at Paytm Docs
-homepage : Homepage of your website where user can go after payment confirmation page
-path_prefix : All node_paytm_pg apis/pages will be available relative to this path prefix
-db_url : Your MongoDB url in case you want to use legacy mongodb connection . You can use multidborm to support MongoDB/Firestore/Sqlite
-id_length: Length of Order ID and User ID
+What it does:
 
-```
+- Adds JSON and URL-encoded body parsing.
+- Captures `req.rawBody` for webhook signature verification (important for Razorpay webhooks).
+- Sets up handlebars view engine expected by payment pages.
 
-### Razorpay
-In case you want to use razorpay , Use the below configuration
-```
-host_url : Host URL of your server . This will be used to redirect user after payment
-view_path : Ignore and dont change unless you know what you are doing . This is the useful in case you want to modify payment init page UI from node_paytm_pg library
-razor_url : https://api.razorpay.com/
-MID : Your Paytm Merchant ID
-KEY : Your generated API Key
-SECRET : Your API Key secret
-homepage : Homepage of your website where user can go after payment confirmation page
-path_prefix : All node_paytm_pg apis/pages will be available relative to this path prefix
-db_url : Your MongoDB url in case you want to use legacy mongodb connection . You can use multidborm to support MongoDB/Firestore/Sqlite
-id_length: Length of Order ID and User ID
+If you skip this call, `createPaymentMiddleware` auto-attaches a default parser and logs a warning. For custom body-parser setups, make sure raw request body is still available as `req.rawBody`.
 
-```
+## How to invoke `createPaymentMiddleware`
 
-### For Open Money
-In case you want to use Open Money https://app.open.money/settings/developer-api/api . Use the below configuration
-```
-host_url : Host URL of your server . This will be used to redirect user after payment
-view_path : Ignore and dont change unless you know what you are doing . This is the useful in case you want to modify payment init page UI from node_paytm_pg library
-open_money_url : SANDBOX https://sandbox-icp-api.bankopen.co/api OR LIVE https://icp-api.bankopen.co/api
-KEY : Your generated API Key
-SECRET : Your API secret
-homepage : Homepage of your website where user can go after payment confirmation page
-path_prefix : All node_paytm_pg apis/pages will be available relative to this path prefix
-db_url : Your MongoDB url in case you want to use legacy mongodb connection . You can use multidborm to support MongoDB/Firestore/Sqlite
-id_length: Length of Order ID and User ID (Optional)
+Signature:
 
+```ts
+createPaymentMiddleware(
+  app,
+  userConfig,
+  db,
+  callbacks?,
+  authenticationMiddleware?,
+  tableNames?
+)
 ```
 
+Required params:
 
-Place these 2 statements in your main nodejs file before calling app.listen(..)
-
-```javascript
+- `app`: your Express app instance.
+- `userConfig`: payment config.
+- `db`: `multi-db-orm` database instance.
 
-/*** 
- * Uncomment in case you want to use multidborm to support 
- * MongoDB / Firestore / SQlite
- * https://www.npmjs.com/package/multi-db-orm
- * Refer to example.js
+Optional params:
 
- const { MultiDbORM, FireStoreDB, MongoDB, SQLiteDB, Sync } = require("multi-db-orm");
-var mongodb = new MongoDB(MONGOURL);
-app.multidborm = mongodb;
+- `callbacks`: `{ onStart(orderId, txn), onFinish(orderId, txn) }`.
+- `authenticationMiddleware`: middleware to protect all payment routes.
+- `tableNames`: override default table/collection names.
 
-*/
+Mounting:
 
-app.set('np_config', {
-    "host_url":"http://127.0.0.1:5542", 
-    "view_path":"/../views/",
-    "MID":"XXXXXXXXXXX",
-    "WEBSITE":"WEBSTAGING",
-    "KEY":"XXXXXXXXXXX",
-    "CHANNEL_ID":"WEB", 
-    "INDUSTRY_TYPE_ID":"Retail",
-    "homepage":"/_pay/home",
-    "path_prefix":"_pay",
-    "db_url":"mongodb://user:password123@db.host.com:5551/dbname_123", // Remove this property in case you want to use multidborm
-    "id_length":10,
-    "logo":"/favicon.ico",
-    "theme_color":"#3399cc",
+- Router paths are relative (`/init`, `/callback`, `/api/createTxn`, etc.).
+- Mount with `app.use('/' + config.path_prefix, router)`.
+- Keep mount path aligned with `config.path_prefix` so generated `payurl` is correct.
 
-    "paytm_url":"https://securegw-stage.paytm.in", // Only For PayTm
-    
-    "razor_url":"https://api.razorpay.com/", // Only For RazorPay
-    "SECRET":"XXXXXXXXXXX", //Only For RazorPay , Your razorpay api key secret
+## Request fields: `RETURN_URL` and `WEBHOOK_URL`
 
-});
+`RETURN_URL` and `WEBHOOK_URL` are optional fields accepted in payment-init/create APIs and stored per transaction.
 
-require('node-paytmpg')(app,express)
+### `RETURN_URL`
 
-```
+If provided:
 
-### Basic Usage 
- 
+- User is redirected to this URL after payment update instead of only rendering library result page.
+- Query params are appended by the middleware:
+  - `status` (for example `TXN_SUCCESS`, `TXN_FAILURE`, `FAILED`)
+  - `ORDERID`
+  - `TXNID` (when available)
+  - `message` in some failure cases
 
-#### Method 1 : Ask user to enter Details
-```
-simply open page /_pay/init in browser
-```
-#### Method 2 : Post these params to /_pay/init using browser form
-```
-NAME
-EMAIL
-MOBILE_NO
-PRODUCT_NAME
-TXN_AMOUNT
-```
+Examples:
 
-####  Method 3 : Using API . Useful for Integrating on Mobile App
-```
-Create an Order by posting to URL /_pay/api/createTxn
+- `https://your-app.com/payment/return?status=TXN_SUCCESS&ORDERID=...&TXNID=...`
+- If URL already has query string, middleware appends with `&`.
 
-NAME
-EMAIL
-MOBILE_NO
-PRODUCT_NAME
-TXN_AMOUNT
+### `WEBHOOK_URL`
 
-This will generate an `orderId` and `payurl` in response . 
-Now Post to  /_pay/init using browser form
+If provided:
 
-NAME
-EMAIL
-MOBILE_NO
-ORDER_ID
+- Middleware posts transaction result payload to this URL on status update.
+- Also used for some error states (for example, transaction not found).
 
-OR
-Simply open `payurl` in your browser
+Typical payload includes transaction/order fields (`orderId`, `txnId`, `status`, etc.) depending on update stage.
 
-```
-APIS
-```
-For Checking Status
+## Create transaction API
 
-method : POST
-path : /_pay/api/status
-Params:
-ORDER_ID
+Endpoint:
 
+```http
+POST /{path_prefix}/api/createTxn
 ```
 
-### Advanced  
-
-You can use callbacks to sync node-paytmpg transactions with you own database using .
-
-```
-var PayTMPG=require('node-paytmpg')(app,express,{
+Required body fields:
 
-    onStart:function(orderid,data)
-    {
-        console.log("Payment has started \n",orderid,data)
-    },
-    onFinish:function(orderid,data)
-    {
-        console.log("Payment Has finished \n",orderid,data)
+- `NAME`
+- `EMAIL`
+- `MOBILE_NO`
+- `TXN_AMOUNT`
+- `PRODUCT_NAME`
 
-    }
+Optional body fields:
 
-})
+- `RETURN_URL`
+- `WEBHOOK_URL`
+- `EXTRA`
 
-var Transaction=PayTMPG.Transaction;
-var User=PayTMPG.User;
+Response includes generated transaction info and `payurl`:
 
- Transaction.findOne({orderId:req.body.ORDERID},function(err,data){
+```json
+{
+  "orderId": "...",
+  "status": "INITIATED",
+  "payurl": "http://host/{path_prefix}/init?to=..."
+}
+```
 
-	console.log(data)	
+## Core routes
 
-  })
+All routes below are mounted under `/{path_prefix}`:
 
+- `GET|POST /init`
+- `GET|POST /callback`
+- `GET|POST /api/webhook`
+- `GET|POST /api/status`
+- `GET|POST /api/transactions`
+- `GET|POST /api/createTxn`
+- `GET|POST /api/createTxn/token`
 
-```
+## Config summary
 
-### Webhooks
+Common:
 
-Webhooks can issued at at `/_pay/api/webhook` and are useful for payments captured late.
+- `host_url`
+- `path_prefix`
+- `KEY`, `SECRET`
 
-#### For razorpay webhook
-Make sure to use the same secret in your webhook as the merchant secret.
-https://razorpay.com/docs/webhooks/
+Gateway-specific:
 
-#### For paytm
-Nothing extra needed
-https://developer.paytm.com/docs/callback-and-webhook/?ref=callbackWebhook
+- Paytm: `paytm_url`, `MID`, `WEBSITE`, `CHANNEL_ID`, `INDUSTRY_TYPE_ID`
+- Razorpay: `razor_url`, `KEY`, `SECRET`
+- PayU: `payu_url`, `KEY`, `SECRET`
+- Open Money: `open_money_url`, `KEY`, `SECRET`
 
-#### For Open Money
-Nothing extra needed
-https://docs.bankopen.com/reference/webhook-url
+UI / behavior:
 
+- `brand`, `logo`, `theme`, `themeName`, `templateDir`, `id_length`
 
-License : GPL
+## Notes
 
-Donate : 
-[<img src="https://www.iconfinder.com/icons/379454/download/png/128">](https://www.instamojo.com/@shiveshnavin)
+- Configure at least one gateway URL: `paytm_url`, `razor_url`, `payu_url`, or `open_money_url`.
+- `host_url` + `path_prefix` are used to build checkout links.
+- This package is designed for Express apps.
 
+## License
 
+MIT

package/app/views/layouts/index.hbs

@@ -13,18 +13,18 @@
   <link rel="shortcut icon" href="data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2016%2016'%3E%3Crect%20width='16'%20height='16'%20rx='3'%20fill='%23ff5722'/%3E%3C/svg%3E" />
   <style>
     :root {
-      --color-primary: {{theme.primary}};
-      --color-accent: {{theme.accent}};
-      --color-surface: {{theme.surface}};
-      --color-text: {{theme.text}};
-      --color-success: {{theme.success}};
-      --color-danger: {{theme.danger}};
+      --color-primary: {{#if theme.primary}}{{theme.primary}}{{else}}#2f8bff{{/if}};
+      --color-accent: {{#if theme.accent}}{{theme.accent}}{{else}}#5ce1e6{{/if}};
+      --color-surface: {{#if theme.surface}}{{theme.surface}}{{else}}#0f1021{{/if}};
+      --color-text: {{#if theme.text}}{{theme.text}}{{else}}#e9ecf2{{/if}};
+      --color-success: {{#if theme.success}}{{theme.success}}{{else}}#24cf5f{{/if}};
+      --color-danger: {{#if theme.danger}}{{theme.danger}}{{else}}#ff6b6b{{/if}};
       --color-outline: rgba(255,255,255,0.08);
       --radius: 14px;
     }
   </style>
 </head>
-<body class="theme-{{themeName}}">
+<body class="theme-{{#if themeName}}{{themeName}}{{else}}dark{{/if}}">
   <div class="shell">
     <header class="shell__header">
       <div class="brand">

package/app/views/result.hbs

@@ -17,7 +17,7 @@
       </div>
       <div class="result-item">
         <p class="label">Transaction ID</p>
-        <p class="value">{{TXNID}}</p>
+        <p class="value">{{txnId}}</p>
       </div>
       <div class="result-item">
         <p class="label">Amount</p>