https://github.com/lehuygiang28/vnpay
An open-source nodejs library support to payment with VNPay (vnpay.vn)
https://github.com/lehuygiang28/vnpay
node nodejs payment vnpay vnpayjs
Last synced: 2 months ago
JSON representation
An open-source nodejs library support to payment with VNPay (vnpay.vn)
- Host: GitHub
- URL: https://github.com/lehuygiang28/vnpay
- Owner: lehuygiang28
- License: mit
- Created: 2023-10-10T16:23:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:07:50.000Z (8 months ago)
- Last Synced: 2024-10-29T21:21:48.193Z (8 months ago)
- Topics: node, nodejs, payment, vnpay, vnpayjs
- Language: TypeScript
- Homepage: https://vnpay.js.org
- Size: 1.13 MB
- Stars: 70
- Watchers: 2
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 📦 vnpayjs
[🇻🇳 Tiếng Việt](./README.md) | [🇺🇸 English](./README_en-US.md)
[](https://www.npmjs.com/package/vnpay)
[](https://www.npmjs.com/package/vnpay)
[](https://www.npmjs.com/package/vnpay)
**Thư viện Node.js tích hợp cổng thanh toán [VNPay](https://vnpay.vn) vào ứng dụng của bạn.**
## 📚 Tài liệu
**Thư viện VNPay:**
- [vnpay.js.org](https://vnpay.js.org/) - Tài liệu chi tiết của thư viện
- [sandbox.vnpayment.vn/apis](https://sandbox.vnpayment.vn/apis) - Tài liệu tích hợp từ VNPay
## 🚀 Cài đặt
> [!TIP]
> Nếu bạn đang sử dụng [`Nestjs`](https://docs.nestjs.com), hãy cài đặt [`nestjs-vnpay`](https://github.com/lehuygiang28/nestjs-vnpay) - một wrapper tích hợp sẵn cho NestJS.
```bash
# NPM
npm install vnpay
# Yarn
yarn add vnpay
# PNPM
pnpm install vnpay
```
## 💡 Cách sử dụng
### Khởi tạo VNPay
```typescript
import { VNPay, ignoreLogger } from 'vnpay';
const vnpay = new VNPay({
// Thông tin cấu hình bắt buộc
tmnCode: '2QXUI4B4',
secureSecret: 'secret',
vnpayHost: 'https://sandbox.vnpayment.vn',
// Cấu hình tùy chọn
testMode: true, // Chế độ test
hashAlgorithm: 'SHA512', // Thuật toán mã hóa
enableLog: true, // Bật/tắt ghi log
loggerFn: ignoreLogger, // Hàm xử lý log tùy chỉnh
// Tùy chỉnh endpoints cho từng phương thức API (mới)
// Hữu ích khi VNPay thay đổi endpoints trong tương lai
endpoints: {
paymentEndpoint: 'paymentv2/vpcpay.html', // Endpoint thanh toán
queryDrRefundEndpoint: 'merchant_webapi/api/transaction', // Endpoint tra cứu & hoàn tiền
getBankListEndpoint: 'qrpayauth/api/merchant/get_bank_list', // Endpoint lấy danh sách ngân hàng
}
});
```
## 🤝 Hỗ trợ & Đóng góp
**vnpayjs là một dự án mã nguồn mở và miễn phí**
Nếu bạn thấy thư viện hữu ích, hãy:
- Tặng sao ⭐️ trên [GitHub](https://github.com/lehuygiang28/vnpay)
- Mời tác giả một ly cà phê ☕️
### Tham gia đóng góp
Tham gia phát triển dự án:
1. Đọc [hướng dẫn đóng góp](.github/CONTRIBUTING.md)
2. Fork dự án và tạo Pull Request
3. Tham gia thảo luận trong [Issues](https://github.com/lehuygiang28/vnpay/issues)
### Những người đóng góp
Cảm ơn tất cả những người đã đóng góp cho dự án:
[](https://github.com/lehuygiang28/vnpay/graphs/contributors)
## 📄 Giấy phép
[MIT](LICENSE) © [Lê Huy Giang](https://github.com/lehuygiang28)