Documentation

Installation RO Payments

You install RO Payments like any other Joomla extension, on the System -> Install -> Extensions page. RO Payments needs Joomla 5 or later and PHP 8.2 or later.

First decide how you are going to use RO Payments:

  • Stand-alone: only the RO Payments payment page and payment links. Install the RO Payments package only.
  • With one or more extensions: payments in for example HikaShop, VirtueMart or RSForm! Pro. Install the RO Payments package plus the addon for each extension. You can use several addons at the same time, for example RSForm! Pro and VirtueMart.

Installation

  1. Download the RO Payments package and the addons you need from https://rolandd.com/downloads/category/ro-payments
  2. In the Joomla administrator, go to System -> Install -> Extensions
  3. On the Upload Package File tab, upload the RO Payments package
  4. Upload the addon of each extension you use with RO Payments. An addon checks that both RO Payments and its extension are installed and stops the installation otherwise.

The package installs:

Extension What it does
RO Payments component Profiles, statuses, messages, transactions, customers and subscriptions
System - RO Payments Receives the messages of the payment provider on /notify and the returning customer on /customer, see notification URLs
Console - RO Payments The ropayments:status-update and ropayments:next-payment-date console commands
Button - RO Payments Payment Link An editor button that adds a payment link to an article
Example - RO Payments An example plugin for developers, see plugin events

Enable the plugins

The installation enables the plugins. To check:

  1. Go to System -> Manage -> Plugins
  2. Search for RO Payments
  3. Make sure System - RO Payments and Console - RO Payments are enabled. Enable Button - RO Payments Payment Link if you want to add payment links to articles.

Check the options

RO Payments works with the default options. Look at them once in Components -> RO Payments -> Transactions -> Options, especially when the site can be reached on more than one address. See Options.

Create the result page

After a payment, the customer comes back to the result page. Usually this is the page of the extension, for example the order page of VirtueMart or J2Commerce. Payments made on the RO Payments payment page need a menu item for the result page, otherwise the result is shown on a non-SEF page.

  1. Go to Menus and click the menu you want to add the page to
  2. Click New
  3. For Menu Item Type select RO Payments -> Result page
  4. On the Link Type tab, set Display in Menu to No. Customers have no reason to go to this page directly.
  5. Click Save & Close

After the installation

Create a profile for your payment provider, see Configure an RO Payments profile.