Plugin - eWAY (Create custom order forms)

RSForm!Pro eWAY Payment Plugin

The RSForm!Pro eWAY Payment Integration Plugin allows you to add a new payment method to the existing Payment Package of RSForm!Pro.

Documentation Please make sure you install the Payment Package plugin first. Download the plugin
Downloading and Installing the plugin
Download

You can download the plugin by logging with your purchase user, then head to Downloads > My Downloads > RSForm!Pro - view all plugins and modules > RSForm!Pro Files > Plugins > "eWAY Plugin for Joomla! 3.x".


Install

In the backend of your Joomla! installation go to the Extensions > Install/Uninstall page, and install the plugin.Next thing is to publish the plugin, to do this go to Extensions > Plug-in Manager, search for the "RSForm! Pro - eWAY" plugin and publish it.


Configuring the plugin

The integration with eWAY requires specific parameters to be added in the Components >> RSForm!Pro >> Configuration >> eWAY tab:


  • eWAY API key: fill in your eWAY API Key, for more information try referring to eWAY documentation
  • eWAY API password: fill in your eWAY API password, for more information try referring to eWAY documentation
  • Live Mode: Yes / No - set to No in order to enable the testing mode
  • Tax Type: Percent (%) / Fixed Rate - Optional, set how you want to tax the form submitters - by a percentage of the total or by a fixed value
  • Tax Value: Set the value that will be applied in conjunction with the Tax Type field. Leave blank if you do not wish to apply a tax

How to use the eWAY Payment plugin

After configuring the eWAY parameters from Components >> RSForm!Pro >> Configuration >> eWAY tab, there are some additional steps that needs to be taken in order the payment process to work properly:

Making sure the form is sent to the payment processor

The payment details will only be sent to the eWAY payment processor if the user selects eWAY from the "Choose Payment" field before submitting the form.

"Choose Payment" field is used in order to allow the users to choose their payment method. It displays the payment methods added to the form in either a Dropdown or Radio Group. It can be shown on the form (allowing the user to select his preferred payment method) or not (forcing the user to pay using the default payment method).

If you are using a single payment method and you need to hide the Choose payment field, this can be achieved by editing the field and setting to "No" the "Show in front-end?" option within the "Attributes" tab.

In order the eWAY payment method to be available within the Choose payment dropdown/radio group, the eWAY field needs to be added in form.

Adding costs

In order to receive funds using RSForm!Pro and eWAY payment plugin, your form needs to include a cost. In order to add costs to your form you can use any of the following fields:

  • Single Product - Adds a single product to the form. For this type of field you can set up a caption, description and a price.
  • Multiple Products - Adds the ability to display multiple products to be purchased either in a Dropdown or a Checkbox. Its items need to be specified in the following manner: price | label (ex: 15 | T-shirt)
  • Donation - Allows the user to type in the amount to be paid inside a standard Textbox.
  • Total - This field is used alongside the Donation, Single and Multiple Products fields. It calculates the total price to be paid.
Mapping form information to eWAY for card processing

1. In order to collect the user's card information, the following fields needs to be added in the form:

  • Card Holder - a textbox field used in order the user to fill in the owner of the card
  • Card Number - a textbox field used in order the user to fill in the credit card number
  • Expiration Month - month dropdown list. Please note that the values for the Month field would have to be in the 'MM' format. (eg. 01, 02, 03).
If you want to also display the month names you can use the pipeline structure: value|label and set up your dropdown items as in the following example: 01|01 January
  • Expiration Year - year dropdown list starting with the current year. Please note that the values for the Year field would have to be in the 'YY' format.(eg. 16, 17)
  • Card Security Code(CSC) - a textbox field used in order the user to fill in the credit card security code

2. In order to map or link the fields between the RSForm!Pro form and eWAY:

  • Head to Components > RSForm!Pro > Manage Forms > Select your form > Properties > eWAY Configuration
  • Select the RSForm!Pro fields corresponding to eWAY
  • Save
Submitting the order form

When the order form is submitted the following actions are taking place:

  • 1. The payment details are sent to eWAY
  • 2. Until the transaction is processed by eWAY a loading message is displayed
  • 3. After eWAY has been successfully processed the transaction, the user will be redirected to the form page and the "Thank you message" will be displayed


Modifying eWay vars through Scripts called after form has been processed

This process is similar to the already existing example regarding the PayPal parameters control. First you will need to get a new instance of the eWay object, this is done with:

 
$payeway = RSFormProEway::getInstance();
 

After this is done you will be able to override the parameters sent to eWay using the following syntax:

 
$payeway->args = array('Payment'=>array('InvoiceReference' => '513456'));
 

The above example will change the invoice number sent to the payment processor (instead of 513456 your can use your custom variable to dynamically send an invoice number). For a more detailed list of parameters available in the API you can check the official eWay variables.

11 Mar 2021
Version 2.0.3
  • Fixed - Credit cards were not stripped when 'Choose Payment' was set as 'Dropdown'.
25 Feb 2021
Version 2.0.2
  • Updated - Tax can now be shown when selecting this payment method.
06 Mar 2020
Version 2.0.1
  • Updated - eWAY PHP Library updated to v1.3.4
05 Mar 2020
Version 2.0.0
  • Added - {grandtotal} and {tax} placeholders.
  • Added - Tax Type and Tax Value.
  • Updated - Code improvements.
  • Fixed - Error messages were not translated correctly.
20 Mar 2019
Version 1.51.5
  • Added - Transaction IDs now show up in a _TRANSACTION_ID column.
  • Updated - Bumped minimum requirements to Joomla! 3.7.0
  • Updated - Assets are now loaded from the /media folder.
  • Updated - Code improvements.
  • Fixed - No error messages were shown in the frontend.
15 Nov 2017
Version 1.51.4
  • Fixed - Overriding options through RSFormProEway::getInstance() was not working correctly.
29 Mar 2017
Version 1.51.3
  • Added - Override options through RSFormProEway::getInstance().
  • Fixed - Duplicating a form would not carry over the eWAY settings.
27 Jun 2016
Version 1.51.2
  • Updated - PHP minimum version set to 5.3
25 Apr 2016
Version 1.51.1
  • Updated - eWAY RapidAPI library.
09 Oct 2015
Version 1.51.0
  • Added - Joomla! automatic updates support.
  • Updated - Bumped minimum requirements to Joomla! 2.5.28 and RSForm! Pro 1.51.0
  • Fixed - SQL installation files were not being run when using the MySQL PDO adapter.
  • Fixed - Uninstalling the plugin would not remove its data.
  • Fixed - Could not ignore fields to be mapped.
10 Jul 2015
Initial Release

18 persons found this article helpful.


Was this article helpful?

Yes No
Sorry about that