Download the PHP package sasa-b/php-bihupp-qrcode without Composer

php-bihupp-qrcode

PHP biblioteka koja implementira BIHUPP10 standard QR koda za instrukcije bankovnog plaćanja u Bosni i Hercegovini.

BIHUPP (Bosansko-hercegovački unutrašnji platni promet) definiše strukturirani tekstualni sadržaj koji se može enkodirati u obliku QR koda, koji banke skeniraju kako bi automatski popunile naloge za plaćanje. Ovaj format je ustanovljen od strane Udruženja Banaka Bosne i Hercegovine.

Dodavanje QR koda u definisanom formatu na računima omogućava krajnjim korisnicima plaćanje pomoću skeniranja QR koda kroz njihovo mobilno bankarstvo.

Za Kotlin biblioteku idite na kotlin-bihupp-qrcode.

Da biste verifikovali validnost QR koda ili da ga generišete ručno, koristite s-co.tech/bihupp-qrcode-verifikator

PHP library implementing the BIHUPP QR Code standard for bank payment instructions in Bosnia and Herzegovina.

BIHUPP (Bosansko-Hercegovački Unutrašnji Platni Promet) defines a structured text payload that can be encoded as a QR code that banks scan to pre-fill payment forms. This format was established by the Association of Banks of Bosnia and Herzegovina.

Adding a QR code in the defined format to invoices enables end-users to make payments by scanning the QR code through their mobile banking app.

For Kotlin library go to kotlin-bihupp-qrcode.

To verify validity of the QR Code or to generate one manually, use s-co.tech/bihupp-qrcode-verifikator

Table of contents

• Requirements
• Installation
• Quick start
• Usage
  • Standard bank transfer
  • Omitting the sender
  • Multiple recipient accounts
  • Including a sender phone number
  • Public revenue payment
  • Reading the payload string
• QR code output
  • SVG (default)
  • PNG / JPEG — GD extension
  • PNG / JPEG — Imagick extension
  • Base64 data-URI link
  • Custom renderer
• Reading a QR code
• Field reference
  • PaymentInstruction constructor
  • Field constraints
  • Allowed character set
• Amount handling
• Payment priority
• Exception handling
• Contribute
• License

Requirements

• PHP 8.3+
• chillerlan/php-qrcode ^6.0
• khanamiryan/qrcode-detector-decoder ^2.0 (required for QR code reading)

Installation

Quick start

Usage

Standard bank transfer

Omitting the sender

When sender is omitted, the bank pre-fills payer details from the logged-in user's session.

Multiple recipient accounts

Up to 20 recipient accounts can be specified.

Including a sender phone number

Public revenue payment (tax, fees, etc.)

Public revenue payments require additional fields grouped in a PublicRevenueInstruction object.

Reading the payload string

PaymentInstruction implements Stringable. Cast it to string to inspect or store the raw BIHUPP payload, or get an array of lines with lines():

QR code output

SVG (default)

PNG / JPEG — GD extension

Requires the gd extension. Throws MissingImageExtension if it is not loaded.

PNG / JPEG — Imagick extension

Requires the imagick extension. Throws MissingImageExtension if it is not loaded.

Base64 data-URI link

Base64Link wraps any ImageRenderStrategy and returns a base64 data URI. Defaults to SVG when no strategy is passed.

Custom renderer

Implement Renderer and RenderStrategy to integrate any QR library or add custom options (logo overlay, colours, size, etc.):

Reading a QR code

Use Reader::read() to scan a BIHUPP QR code image and reconstruct a PaymentInstruction from it. Pass either a file path or a binary blob as the source.

By default GD is used to decode the image. Pass ImageExtension::Imagick as the second constructor argument to use Imagick instead:

Field reference

PaymentInstruction constructor

Field constraints

Sender / Recipient

Payment detail

Public revenue fields

Allowed character set

All text fields accept: alphanumeric characters, Serbian/Croatian/Bosnian diacritics (č ć đ š ž and their uppercase forms), and the symbols , : . ? ( ) + ' / - and space.

Fields with stricter formats (tax IDs, codes, phone numbers) enforce their own format in addition to the above.

Amount handling

Amount stores the value as an integer number of pennies (pfeniga) and zero-pads it to 15 digits in the payload. Use the factory helpers for other input types:

Payment priority

Exception handling

All validation runs at construction time. Exception types extend BihuppQRCodeException.:

Catch a specific type, or use BihuppQRCodeException to handle any library exception in one clause:

Contribute

Run code quality check before raising PRs.

License

MIT — see LICENSE.