Setting up the withdrawal button

Joomla 5 or 6, PHP 8.3.0 or newer, MySQL 8.0.13 or newer, or MariaDB 10.4 or newer.

PHP 8.1 and 8.2 no longer receive security fixes. Because JoomRevoke handles your customers' contact details, we require 8.3, even though Joomla itself starts lower. On an older version the installation stops before anything is copied.

In the backend, under System → Install → Extensions, upload the file pkg_joomrevoke.zip.

Installed in one go: the component, the withdrawal button module, a backend overview module, a system plugin and a task plugin. JoomRevoke then appears under Components → JoomRevoke.

Add a menu item. Menus → your menu → New menu item, type JoomRevoke → Withdrawal form. Best placed in the footer menu, next to your legal notice and privacy policy.

Place the button. System → Site Modules → New → JoomRevoke - Withdrawal button. Choose a position, set menu assignment to On all pages. Leave the label empty, and it then reads „Vertrag widerrufen“, the wording the law requires.

Enter CSS classes so the button matches your other buttons. Cassiopeia: btn btn-primary. YOOtheme Pro: uk-button uk-button-primary.

No menu item? That works too, in either of two ways. The law asks for the button, not for the menu entry.

First way: no menu item at all. The form is reachable without one, at the component's default address: /component/joomrevoke. On a multilingual site the language prefix comes first, so /en/component/joomrevoke. The withdrawal button links there by itself; you never have to enter this address anywhere.

Second way: your own address, but no visible entry. If /component/joomrevoke looks too technical to you and you would rather have /withdraw-contract, you need a menu item for it, because in Joomla only a menu item creates an address of its own. A menu item only becomes visible, though, when a menu module displays the menu it sits in. That part can simply be left out:

1. Create a menu of your own under Menus → Manage → Add New Menu, called "Hidden" for example.
2. In that menu, create the menu item of type JoomRevoke → Withdrawal form and give it the alias you want, such as withdraw-contract.
3. Do not publish a menu module for this menu.

The entry then appears in no navigation at all, the address exists all the same, and the withdrawal button links to it automatically.

Under Components → JoomRevoke → Options, tab Notifications, enter the address that should receive word of new withdrawals. Leave it empty and the sender address from Joomla's configuration is used.

By default that message carries only the reference and the time, no personal data. E-mails travel unencrypted across other people's servers and sit in mailboxes for years. The full details are in the backend anyway.

The acknowledgement to the customer is unaffected. It is mandatory and always sent.

Under Components → JoomRevoke → Withdrawals you find every request. Four states are available: New, In progress, Closed, Rejected. Plus an internal note only you can see.

Every change of status is recorded with time and user account in the history. What the customer wrote cannot be edited, because it is their record and yours.

The Record button opens a printable view without any interface. Export hands you every request as a CSV file.

Enter the key from your order confirmation under Components → JoomRevoke → Options, tab Licence. What the licence server answered is shown below the field.

Updates are installed through System → Update → Extensions. Without a valid key the update source is switched off, so Joomla does not offer you an update whose download would then be refused.

None of that touches the function: the withdrawal button behaves the same with a licence, with an expired one, and with none at all.

What is missing without a valid licence are the updates - and with them every adjustment to new Joomla releases, to changed rules and to closed security holes. Keep the licence current if you want your site to stay current too.

JoomRevoke deletes nothing by itself. No request disappears after a period, and nothing tidies up in the background. What is in the list stays there until you remove it.

To delete, mark the rows under Components → JoomRevoke → Withdrawals and use Delete in the toolbar. You are asked first, and the deletion is logged.

Nothing vanishing on its own is deliberate: how long you must and may keep a withdrawal depends on your sector. A period set by us would destroy evidence you may need in a dispute.