Options
All
  • Public
  • Public/Protected
  • All
Menu

SEPA Payment Code

styled with prettier Travis Coveralls Dev Dependencies Donate

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?

Usage

npm install sepa-payment-code --save
# or
yarn add sepa-payment-code

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 a QR code generator then try scanning it with your banking app.

Index

Classes

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc