{"_id":"sepay-pg-node","name":"sepay-pg-node","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"sepay-pg-node","version":"1.0.0","description":"Thư viện Node.js SDK chính thức của cổng thanh toán SePay. Hỗ trợ các hình thức tích hợp thanh toán quét mã chuyển khoản ngân hàng VietQr, quét mã chuyển khoản Napas, thanh toán qua thẻ quốc tế/nội địa Visa/Master Card/JCB.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","build:watch":"tsc --watch","dev":"tsx src/index.ts","lint":"eslint src/**/*.ts","lint:fix":"eslint src/**/*.ts --fix","format":"prettier --write src/**/*.ts","prepublishOnly":"npm run build && npm test","clean":"rimraf dist"},"keywords":["sepay","payment","gateway","sdk","nodejs","typescript"],"license":"MIT","homepage":"https://sepay.vn","engines":{"node":">=16.0.0"},"devDependencies":{"@types/jest":"^29.5.12","@types/node":"^20.11.24","@typescript-eslint/eslint-plugin":"^7.1.1","@typescript-eslint/parser":"^7.1.1","eslint":"^8.57.0","jest":"^29.7.0","prettier":"^3.2.5","rimraf":"^5.0.5","ts-jest":"^29.1.2","tsx":"^4.7.1","typescript":"^5.4.2"},"dependencies":{"axios":"^1.11.0"},"_id":"sepay-pg-node@1.0.0","gitHead":"62178220f36cda2f6657731ef182ecd84dd67e2f","_nodeVersion":"20.19.5","_npmVersion":"10.8.2","dist":{"integrity":"sha512-MeU0o3vf6IQRecSxrDYDbcDQUg625jZVR+aLSPDhBKAbjttfapCFoJ6vro7BFngIW3ylIMSf+Y5safC7iRJmJQ==","shasum":"1244cb1aea150ef40f03f916f62d1ff5c6b772fa","tarball":"https://registry.npmjs.org/sepay-pg-node/-/sepay-pg-node-1.0.0.tgz","fileCount":27,"unpackedSize":26744,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQC5OJSLQRmd8/G7TJxgyv0AqyebPasve8WLObGLk2Sa0wIgUCXKJyGENcbD973eVVB94Q5OT//LMxqud+EjP+6aGek="}]},"_npmUser":{"name":"sepayvn","email":"quochien@sepay.vn"},"directories":{},"maintainers":[{"name":"sepayvn","email":"quochien@sepay.vn"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sepay-pg-node_1.0.0_1760963066485_0.5656992520842348"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-20T12:24:26.402Z","1.0.0":"2025-10-20T12:24:26.667Z","modified":"2025-10-20T12:24:27.005Z"},"maintainers":[{"name":"sepayvn","email":"quochien@sepay.vn"}],"description":"Thư viện Node.js SDK chính thức của cổng thanh toán SePay. Hỗ trợ các hình thức tích hợp thanh toán quét mã chuyển khoản ngân hàng VietQr, quét mã chuyển khoản Napas, thanh toán qua thẻ quốc tế/nội địa Visa/Master Card/JCB.","homepage":"https://sepay.vn","keywords":["sepay","payment","gateway","sdk","nodejs","typescript"],"license":"MIT","readme":"# SePay Node.js SDK\n\nThư viện Node.js SDK chính thức của cổng thanh toán SePay. Hỗ trợ các hình thức tích hợp thanh toán quét mã chuyển khoản ngân hàng VietQr, quét mã chuyển khoản Napas, thanh toán qua thẻ quốc tế/nội địa Visa/Master Card/JCB.\n\n## Yêu cầu\n\n- Node 16 hoặc cao hơn\n\n## Cài đặt\n\nCài đặt qua thư mục đã tải xuống:\n```\nnpm install github:sepay/sepay-pg-node\n```\n\n## Bắt đầu nhanh\n\nThư viện cần cấu hình các thông tin từ đơn vị bán hàng của bạn (merchant) được lấy từ my.sepay.vn.\n\n```ts\nimport { SePayPgClient } from 'sepay-pg-node';\n\nconst client = new SePayPgClient({\n  env: 'sandbox',\n  merchant_id: 'YOUR_MERCHANT_ID',\n  secret_key: 'YOUR_MERCHANT_SECRET_KEY',\n});\n```\n\nTạo biểu mẫu thanh toán cho đơn hàng có mã `DH0001`, số tiền thanh toán là 10.000đ. Sau khi thanh toán thành công sẽ tự động chuyển hướng về đường dẫn: https://example.com/order/DH0001\n\n```ts\nconst fields = client.checkout.initOneTimePaymentFields({\n  operation: 'PURCHASE',\n  order_invoice_number: 'DH0001',\n  order_amount: 10000,\n  currency: 'VND',\n  success_url: 'https://example.com/order/DH0001'\n  order_description: 'Thanh toan don hang DH0001',\n});\n\nconsole.log(fields)\n```\n\nKết quả trả về kiểu object key-value\n\n```ts\n{\n  merchant: 'YOUR_MERCHANT_ID',\n  operation: 'PURCHASE',\n  order_invoice_number: 'DH0001',\n  order_amount: 10000,\n  currency: 'VND',\n  order_description: 'Thanh toan don hang DH0001',\n  success_url: 'https://example.com/order/DH0001'\n  signature: 'AUTO_GENERATED_SIGNATURE'\n}\n```\n\nKết hợp với `client.checkout.initCheckoutUrl()` để lấy URL và tạo `form` xử lý thanh toán sau khi đã tạo đơn hàng.\n\n```tsx\nreturn (\n  <form action={client.checkout.initCheckoutUrl()} method=\"POST\">\n    {Object.keys(fields).map(field => <input type=\"hidden\" name={field} value={fields[field]} />)}\n    <button type=\"submit\">Thanh toán</button>\n  </form>\n)\n```\n\n## Cấu hình\n\n```ts\nimport { SePayPgClient } from 'sepay-pg-node';\n\nconst client = new SePayPgClient({\n  env: 'sandbox',\n  merchant_id: 'YOUR_MERCHANT_ID',\n  secret_key: 'YOUR_MERCHANT_SECRET_KEY',\n});\n```\n\n| Tham số | Mô tả |\n| -| - |\n| **env**               | Môi trường hiện tại, giá trị hỗ trợ: `\"sandbox\"`, `\"production\"` |\n| **merchant\\_id**      | Mã đơn vị merchant                                               |\n| **secret\\_key**       | Khóa bảo mật merchant                                            |\n| **api\\_version**      | Phiên bản API sử dụng, giá trị hỗ trợ: `\"v1\"`                    |\n| **checkout\\_version** | Phiên bản trang thanh toán sử dụng, giá trị hỗ trợ: `\"v1\"`       |\n\n\n## Khởi tạo đối tượng cho biểu mẫu thanh toán\n\nSử dụng `client.checkout.initCheckoutUrl()` để tạo URL thanh toán theo thông tin đã cấu hình.\n\n| Môi trường | URL thanh toán |\n| - | - |\n| **sandbox** | https://sandbox.pay.sepay.vn/[VERSION]/init |\n| **production** | https://pay.sepay.vn/[VERSION]/init |\n\n### Đơn hàng thanh toán 1 lần\n```ts\nclient.checkout.initOneTimePaymentFields({\n  operation: 'PURCHASE';\n  payment_method: 'BANK_TRANSFER' | 'NAPAS_BANK_TRANSFER';\n  order_invoice_number: string;\n  order_amount: number;\n  currency: string;\n  order_description?: string;\n  customer_id?: string;\n  success_url?: string;\n  error_url?: string;\n  cancel_url?: string;\n  custom_data?: string;\n});\n```\n\n| Tham số                    | Bắt buộc | Mô tả                                                                        |\n| -------------------------- | -------- | -------------------------------------------------------------------------\n| **operation**              | ✔︎       | Loại giao dịch, hiện chỉ hỗ trợ: `\"PURCHASE\"`                                |\n| **payment\\_method**        | ✔︎       | Phương thức thanh toán: `\"BANK_TRANSFER\"`, `\"NAPAS_BANK_TRANSFER\"` |\n| **order\\_invoice\\_number** | ✔︎       | Mã đơn hàng/hoá đơn (duy nhất)                                               |\n| **order\\_amount**          | ✔︎       | Số tiền giao dịch                                                            |\n| **currency**               | ✔︎       | Đơn vị tiền tệ (VD: `\"VND\"`, `\"USD\"`)                                        |\n| **order\\_description**     |         | Mô tả đơn hàng                                                               |\n| **customer\\_id**           |         | Mã khách hàng (nếu có)                                                       |\n| **success\\_url**           |         | URL callback khi thanh toán thành công                                       |\n| **error\\_url**             |         | URL callback khi xảy ra lỗi                                                  |\n| **cancel\\_url**            |         | URL callback khi người dùng hủy thanh toán                                   |\n| **custom\\_data**           |         | Dữ liệu tuỳ chỉnh (merchant tự định nghĩa)                                   |\n\nDữ liệu trả về dạng object:\n\n| Tham số                    | Bắt buộc | Mô tả                                                                        |\n| -------------------------- | -------- | ---------------------------------------------------------------------------- |\n| **merchant**               | ✔︎        | Mã merchant                                                                  |\n| **operation**              | ✔︎        | Loại giao dịch, hiện chỉ hỗ trợ: `\"PURCHASE\"`                                |\n| **payment\\_method**        | ✔︎        | Phương thức thanh toán: `\"BANK_TRANSFER\"`, `\"NAPAS_BANK_TRANSFER\"` |\n| **order\\_invoice\\_number** | ✔︎        | Mã đơn hàng/hoá đơn (duy nhất)                                               |\n| **order\\_amount**          | ✔︎        | Số tiền giao dịch                                                            |\n| **currency**               | ✔︎        | Đơn vị tiền tệ (VD: `\"VND\"`, `\"USD\"`)                                        |\n| **order\\_description**     | ✔︎        | Mô tả đơn hàng                                                               |\n| **customer\\_id**           |          | Mã khách hàng (nếu có)                                                       |\n| **success\\_url**           |          | URL callback khi thanh toán thành công                                       |\n| **error\\_url**             |          | URL callback khi xảy ra lỗi                                                  |\n| **cancel\\_url**            |          | URL callback khi người dùng hủy thanh toán                                   |\n| **custom\\_data**           |          | Dữ liệu tuỳ chỉnh (merchant tự định nghĩa)                                   |\n| **signature**              | ✔︎        | Chữ ký bảo mật (HMAC SHA256) để xác thực dữ liệu trả về                      |\n\n## API\n\nSDK cung cấp các phương thức để gọi Open API cho cổng thanh toán SePay.\n\n### Tra cứu danh sách đơn hàng\n\n```ts\nclient.order.all({\n  per_page?: number,\n  q?: string,\n  order_status?: string,\n  created_at?: string,\n  from_created_at?: string,\n  to_created_at?: string,\n  customer_id?: string | null,\n  sort?: {\n    created_at?: string\n  }\n})\n```\n\n### Xem chi tiết đơn hàng\n\n```ts\nclient.order.retrieve(order_invoice_number: string)\n```\n\n### Hủy giao dịch đơn hàng (dành cho thanh toán bằng thẻ tín dụng)\n\n```ts\nclient.order.voidTransaction(order_invoice_number: string)\n```\n\n### Hủy đơn hàng (dành cho thanh toán bằng quét mã QR)\n\n```ts\nclient.order.cancel(order_invoice_number: string)\n```\n\n## Giấy phép sử dụng\n\nThư viện sử dụng giấy phép MIT. Xem chi tiết [LICENSE](LICENSE).\n\n## Hỗ trợ\n\n- Email: <info@sepay.vn>\n- Tài liệu: <https://docs.sepay.vn>","readmeFilename":"README.md","_rev":"1-ae4ebed0f0e295468d18637153388bd3"}