Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashokshau/upi-qr-generator
A lightweight Go-based API for generating UPI payment QR codes and secure payment pages. Fast, simple, and easy to integrate with any application.
https://github.com/ashokshau/upi-qr-generator
go payment-gateway payments qr-code qr-code-generator qr-generator qrcode upi upi-payment upi-qrcode-generator
Last synced: about 1 month ago
JSON representation
A lightweight Go-based API for generating UPI payment QR codes and secure payment pages. Fast, simple, and easy to integrate with any application.
- Host: GitHub
- URL: https://github.com/ashokshau/upi-qr-generator
- Owner: AshokShau
- License: mit
- Created: 2024-11-13T14:57:19.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-21T16:58:09.000Z (2 months ago)
- Last Synced: 2024-11-21T17:21:12.857Z (2 months ago)
- Topics: go, payment-gateway, payments, qr-code, qr-code-generator, qr-generator, qrcode, upi, upi-payment, upi-qrcode-generator
- Language: Go
- Homepage: https://qr.abishnoi.me/
- Size: 270 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UPI QR Code Generator API
A lightweight API for generating UPI QR codes and rendering a secure payment page. This project is built using Go and
the Gorilla Mux router.
Example of payment page
## Features
- Generate QR codes for UPI payments.
- Serve a customizable payment page with UPI details.
- Easy-to-use RESTful endpoints.
- Static assets support for additional resources.
## Requirements
- Go - https://golang.org
- Modules:
- `github.com/skip2/go-qrcode`
## Installation
1. Clone this repository:
```bash
git clone https://github.com/AshokShau/upi-qr-generator.git
cd upi-qr-generator
```
2. Install dependencies:
```bash
go mod download
```
3. Run the application:
```bash
go run main.go
```
4. The server will start at `http://localhost:3000`.
## Project Structure
```
upi-qr-generator/
├── api/ // API endpoint handlers for vercel
│ ├── index.go // Handles /
│ ├── pay.go // Handles /pay
│ ├── qr.go // Handles /qr
├── str/ // String constants and HTML templates
│ ├── files.go // HTML templates for payment page
│ ├── handlers.go // Handlers for API endpoints
├── main.go // Main entry point of application
├── README.md // Project README file
└── LICENSE // Project license file
```
## API Endpoints
### 1. `GET /`
Redirects to the homepage (`static/index.html`) that provides usage information.
### 2. `GET /qr`
Generates a UPI QR code based on the provided query parameters:
- **Parameters**:
- `vpa` (string, required): UPI ID (e.g., `example@upi`).
- `name` (string, optional): Payee name (e.g., `John Doe`).
- `amount` (float, required): Payment amount (e.g., `100.50`).
- **Example**:
```
/qr?vpa=example@upi&name=John+Doe&amount=100.50
```
- **Response**:
A PNG image of the QR code.
### 3. `GET /pay`
Renders a payment page with UPI details:
- **Parameters**:
- `vpa` (string, required): UPI ID (e.g., `example@upi`).
- `name` (string, optional): Payee name (e.g., `John Doe`).
- `amount` (float, required): Payment amount (e.g., `100.50`).
- **Example**:
```
/pay?vpa=example@upi&name=John+Doe&amount=100.50
```
- **Response**:
A rendered HTML page with the QR code and payment details.
## How It Works
1. The `/qr` endpoint generates a UPI QR code using the `qrcode` library.
2. The `/pay` endpoint serves a payment page with details dynamically rendered from the `template.html` file.
3. Static assets such as styles and templates are served from the `static` folder.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## Author
[**Ashok Shau**](https://github.com/AshokShau)
Feel free to explore, use, or contribute to this project. If you encounter any issues or have suggestions, open a GitHub
issue or create a pull request!