#6220 QR Code plugin

Parent Category:: DPCalendar

Category:: Payment plugins

Last Updated:: Allon Moritz, Thursday, 26 June 2025 07:58

Created:: Monday, 06 August 2018 13:17

Hits:: 4803

This feature is part of the DPCalendar Professional subscription.

SubscribePHP 8Joomla 4.4Joomla 5

Introduction

The QR code payment plugin can be used for any kind of offline payment when QR code invoices are issued. The booking itself has the state On hold, when not changed in the settings, as soon as the user has finished the booking process. This means the web site admin needs to QR manually activate the booking when the payment has arrived on the bank account.

The Qr code plugin actually supports any QR code image or the Swiss QR code invoice system. Therefor, when Swiss QR code is used, the global DPCalendar configuration needs to have as currency either "CHF" or "EUR" set, as only these two are supported. Also the zip and city values must be filled when the Swiss QR type is used to be able to properly generate the QR code.

Configure the plugin

The DPCalendar QR code plugin allows to add unlimited Swiss bank accounts to DPCalendar. When the plugin is opened in the back end, then you can click on the "+" button to add a new configuration. There you can fill the following fields:

ID
The ID of the configuration, must be a unique integer amongst the different configurations within the plugin.
Title
The title of the configuration. Appears in the drop down in the event form where you can select individual payment providers.
Description
The description which will be shown on the front end provider selection list when confirming the booking.
Icon
The icon which will be shown on the front end provider selection list when confirming the booking.
Status
The publishing status of the payment provider.
Payment date
The date till when the payment must be done. Can be an absolute date like 2022-08-18 or relative like '-2 days'.
Payment date type
The payment date is relative, then this setting controls if it should be relative to the booking or event date.
Send invoice
A flag to define if the invoice should be sent or not during the booking process.
Booking status
The status the booking should have when the booking process is finished.
Type
Either a QR code image or Swiss QR code invoices are supported.
QR Code image
The QR code image.
IBAN
The new Swiss IBAN number for QR code invoices.
BESR ID
The new Swiss BESR ID for QR code invoices.
Name
The name of the creditor.
Street
The street of the creditor address.
City
The city of the creditor address.
Country
The country of the creditor address.
Custom CSS
The invoice for the PDF is rendered from a template file, similar to views or modules. The custom CSS option allows to add some styling to the invoice without the need to do an override. More about the invoice process can be found in the chapter below.
Fee amount The amount which should be added, when this payment provider is used for payment.
Fee type Should the fee be added as fixed amount or percentage of the price of the booking.

Invoice

The invoice is sent out as soon as the attendee has selected the QR code payment provider and clicks on the confirm button. The invoice is rendered from the file /plugins/dpcalendarpay/qr/tmpl/invoice.php, means the site admin can do a layout override, when some adaptions are needed.

A special parameter in the invoice is the "qrcode" parameter which contains the QR code HTML text from the payment provider configuration. The DPCalendar PDF options like header, logo or address are used in the invoice as well to be inline with the other system generated PDF files.

The subject of the mail is created from the language string "PLG_DPCALENDARPAY_QR_PAYMENT_PROVIDER_TYPE_IMAGEQR_INVOICE_SUBJECT_TEXT" or "PLG_DPCALENDARPAY_QR_PAYMENT_PROVIDER_TYPE_SWISSQR_INVOICE_SUBJECT_TEXT" and the message from "PLG_DPCALENDARPAY_QR_PAYMENT_PROVIDER_TYPE_IMAGEQR_INVOICE_MESSAGE_TEXT" or "PLG_DPCALENDARPAY_QR_PAYMENT_PROVIDER_TYPE_SWISSQR_INVOICE_MESSAGE_TEXT", they both depend which type of QR code is used. The available variables are explained below.

The file name of the invoice is generated from the language string "PLG_DPCALENDARPAY_MANUAL_INVOICE_FILENAME", while the %s variable in the string is the uid.

Variables

We are using the mustache templating system to inject and render variables in the language strings as described in the Output rendering article. Means you can use a variable like {{price}} in the string and it will be replaced with the real value. For every language string below are the following variables available:

id
The id of the booking.
uid
The uid of the booking.
price
The price of the booking.
email
The email address of the attendee.
country
The country address of the attendee.
province
The province address of the attendee.
city
The city address of the attendee.
zip
The zip address of the attendee.
street
The street address of the attendee.
number
The number address of the attendee.
telephone
The telephone address of the attendee.
currency
The currency of the price in the booking.
currencySymbol
The currency symbol of the price in the booking.
bankInformation
The bank information from the statement.
paymentDueDate
The date when the payment must arrive.
invoiceDetails
The text from the invoice.
bookingDetails
The details of the booking.
field-[*]
The booking custom fields objects. You can directly access every field with the prefix field- and then the name. For example when the field has the name XYZ, you can use the way {{#field-XYZ}}{{value}}{{/field-XYZ}} to render the value of it.

Troubleshooting

No logo image is displayed in the PDF
Make sure that in the PHP configuration on your web server (mostly an ini file) is the PHP function "allow_url_fopen" enabled.