README

Introduction

BezahlCode is a PHP library for creating BezahlCode QR-Code images and URIs.

Table of Contents

• Installation
• Usage
  • SEPA Transfer
  • Classic Transfer
  • Other Types
• Bugs / To Do
• Credits

Requirements

BezahlCode requires at least PHP 8.2.

If you're using an older PHP version, you can install:

• BezahlCode 3.x which is compatible to PHP versions >= 7.3 or
• BezahlCode 2.x which is compatible to PHP versions >= 7.1 or
• BezahlCode 1.x which is compatible to PHP versions >= 5.3.

Installation

BezahlCode is installed via Composer:

Just add it to your composer.json by running:

composer require mjaschen/bezahlcode

Usage

SEPA Transfer

Output a BezahlCode image directly to the browser:

<?php

use MarcusJaschen\BezahlCode\Type\SepaTransfer;

$bezahlCode = new SepaTransfer();

$bezahlCode->setTransferData(
    "Marcus Jaschen",
    "DE12345678901234567890",
    "SPARDEFFXXX",
    99.99,
    "Test SEPA Transfer"
);

header('Content-type: image/png');
echo $bezahlCode->getBezahlCode('png');

Save a BezahlCode image to a file:

<?php

use MarcusJaschen\BezahlCode\Type\SepaTransfer;

$bezahlCode = new SepaTransfer();

$bezahlCode->setTransferData(
    "Marcus Jaschen",
    "DE12345678901234567890",
    "SPARDEFFXXX",
    99.99,
    "Test SEPA Transfer"
);

$file = sys_get_temp_dir() . DIRECTORY_SEPARATOR . "bezahlcode_test.svg";

$bezahlCode->saveBezahlCode($file, 'svg');

Get BezahlCode URI:

<?php

use MarcusJaschen\BezahlCode\Type\SepaTransfer;

$bezahlCode = new SepaTransfer();

$bezahlCode->setTransferData(
    "Marcus Jaschen",
    "DE12345678901234567890",
    "SPARDEFFXXX",
    99.99,
    "Test SEPA Transfer"
);

echo $bezahlCode->getBezahlCodeURI();

Classic Transfer

Output a BezahlCode image directly to the browser:

<?php

use MarcusJaschen\BezahlCode\Type\Transfer;

$bezahlCode = new Transfer();

$bezahlCode->setTransferData(
    "Marcus Jaschen",
    "1234567890",
    "10050000",
    99.99,
    "Test Classic Transfer"
);

header('Content-type: image/png');
echo $bezahlCode->getBezahlCode();

Saving a BezahlCode to a file and getting the BezahlCode URI works as described in the SEPA Transfer section.

Other Types

• Periodic Transfer
• Periodic SEPA Transfer
• Direct Debit
• SEPA Direct Debit

Bugs / To Do

• TODO: implement missing authorities (contact, contactv2)
• TODO: write more Tests

Credits

• Marcus Jaschen
• QR Code
• BezahlCode
• BezahlCode Specification (PDF)