Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jovandeginste/payme
QR code generator (ASCII & PNG) for SEPA payments
https://github.com/jovandeginste/payme
ascii cli png qr sepa
Last synced: about 2 months ago
JSON representation
QR code generator (ASCII & PNG) for SEPA payments
- Host: GitHub
- URL: https://github.com/jovandeginste/payme
- Owner: jovandeginste
- License: mit
- Created: 2021-05-03T21:56:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T08:33:12.000Z (4 months ago)
- Last Synced: 2024-08-09T09:54:16.202Z (4 months ago)
- Topics: ascii, cli, png, qr, sepa
- Language: Go
- Homepage:
- Size: 5.54 MB
- Stars: 85
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - payme - QR code generator (ASCII & PNG) for SEPA payments. (Financial / Search and Analytic Databases)
- awesome-go-extra - payme - 05-03T21:56:06Z|2022-05-24T06:31:04Z| (Financial / Advanced Console UIs)
README
# QR code generator (ASCII & PNG) for SEPA payments
[](https://pkg.go.dev/github.com/jovandeginste/payme)
[](https://goreportcard.com/report/github.com/jovandeginste/payme)
[](https://raw.githack.com/wiki/jovandeginste/payme/coverage.html)
## What is this?
This tool makes it easier for people (in Europe) to pay with bank transfers. It does not serve as a payment gateway or
anything similar. It does no payment verification at all, it simply provides the necessary payment information in a QR
code, which may be scanned by the person who wants to pay.
The QR code contains the information necessary for a bank transaction in the form of a [SEPA credit
transfer](https://epc-qr.eu/). It can be used to prefill the transaction form if your [banking app supports](#Support)
payment by QR code.
The process of generating the QR code is entirely local and offline. It can be printed in ASCII in the terminal, or
exported as a PNG for inclusion in eg. a web page or a mail.
One QR code can be used without limit, but will always contain the same payment information: amount, remittance message,
destination account. More than one person can scan the same code to pay the same amount (eg. split a bill with friends),
or one person can scan the code on a recurring base (eg. you pay your internet invoice every month and it's a fixed
price)
## Install
```bash
$ go install github.com/jovandeginste/payme@latest
```
Usage:
```bash
Generate SEPA payment QR code
Usage:
payme [flags]
Flags:
--amount float Amount of the transaction
--bic string BIC of the beneficiary
--character-set int QR code character set (default 2)
--debug print debug output
--file string write code to file, leave empty for stdout
-h, --help help for payme
--iban string IBAN of the beneficiary
--name string Name of the beneficiary
--output string output type: png or stdout (default "stdout")
--purpose string Purpose of the transaction
--remittance string Remittance (message)
--structured Make the remittance (message) structured
--qr-version int QR code version (default 2)
```
You can set some default values in your ENV, eg.:
```bash
export PAYME_IBAN=DE71110220330123456789
export PAYME_NAME="Franz Mustermänn"
export PAYME_BIC=BHBLDEHHXXX
```
Generate QR code as text, print on the console:
```bash
$ payme \
--name "Franz Mustermänn" \
--iban "DE71110220330123456789" \
--amount 12.3 \
--remittance "RF18539007547034"
```
Generate QR code as png, save as file:
```bash
$ payme \
--name "Franz Mustermänn" \
--iban "DE71110220330123456789" \
--amount 12.3 \
--remittance "RF18539007547034" \
--output png \
--file QR.png
```
## Support
Please provide feedback if your banking app supports or does not support these QR codes.
The QR code is tested with the mobile apps of these banks:
### Belgium
| Bank | Support |
| ------- | ------------------------------------------ |
| Belfius | Yes |
| Fortis | Problems with characters in the remittance |
| KBC | Yes |
## References
- https://en.wikipedia.org/wiki/Single_Euro_Payments_Area
- https://en.wikipedia.org/wiki/EPC_QR_code
- https://epc-qr.eu/