sepa-payment-code
v1.0.3
Published
Generates SEPA payment codes for embedding in QR codes
Downloads
2,743
Readme
SEPA Payment Code
Do you want to make it easier for your clients to pay your invoices? This library generates a payment code for embedding in a QR code. The QR code will be scannable by many mobile banking apps (SEPA/Europe). It's based on the European Payments Council's standard.
What are the advantages of using this package?
- Written in TypeScript
- Allows you to pick your own QR library! Do you use React? Do you prefer artistic QR codes?
- Extensive documentation
Usage
npm install sepa-payment-code --save
# or
yarn add sepa-payment-code --save
Using qrcode.react (npm install qrcode.react --save
)
import { PaymentCode } from "sepa-payment-code";
const YourComponent = () => {
const paymentCode = new PaymentCode("Your name", "BE71096123456769", 10.1);
return <QRCode value={paymentCode.getPayload()} />;
};
Using qrcode (npm install qrcode --save
)
import { PaymentCode } from "sepa-payment-code";
const paymentCode = new PaymentCode("Your name", "BE71096123456769", 10.1);
QRCode.toCanvas(canvas, paymentCode.getPayload());
Add structured text (reference)
new PaymentCode("Your name", "BE71096123456769", 10.1, "123456789");
Add unstructured text
new PaymentCode("Your name", "BE71096123456769", 10.1, undefined, "Invoice 2018001");
What does a payload look like?
const paymentCode = new PaymentCode("Name", "BE71096123456769", 10.1, undefined, "Invoice 2018001");
console.log(paymentCode.getPayload());
BCD
002
1
SCT
Name
BE71096123456769
EUR10.1
Invoice 2018001
You can copy this into an QR code generator then try scanning it with your banking app.