VirtueMart 2

The Viva Wallet plugin for VirtueMart 2 enables you to receive payments to VirtueMart 2 on Joomla via the Viva Wallet payment gateway.

Prerequisites

• Log in to the Viva Wallet banking app, demo or live .
• Find your Merchant ID and API Key.
• Download vm2_plugin_vivawallet.zip to your desktop.

Setup instructions

Adding the Viva Wallet plugin to VirtueMart 2 consists of the following steps.

Step 1: Create a payment source

To add a new payment source in the Viva Wallet banking app:

1. Click on Sales in the left navigation:
   
   

2. Click on Online payments in the Sales menu.

3. Click on Websites / apps in the Online payments menu:
   
   

4. Click on the Add Website/App button in the top right-hand corner:
   
   
   The New Payment Source dialog box is displayed:
   
   

5. Complete the fields as follows:

   • Code – the four-digit number in the top-left of the dialog box is the ‘Source Code’. Make a note of it for use in your plugin.
   • Source Name – give your payment source a source name so you can recognise it in your reports.
   • Linked Wallet – link the payment source to the required wallet.
   • Protocol – if your e-commerce platform uses SSL on the checkout, select https, otherwise use http.
   • Domain Name – enter the domain name to be associated (without the protocol. i.e. use [(www.)yourdomain.com], not http://[yourdomain].com). If the site uses www, it must be specified and visa versa.
   • Integration method – leave this with redirection selected.
   • Company Logo - a PNG of your company logo to be displayed on the Viva Wallet payment page.
   • Success URL – enter index.php?option=com_virtuemart&view=pluginresponse&task=pluginresponsereceived&bnkact=success
   • Failure URL – enter index.php?option=com_virtuemart&view=pluginresponse&task=pluginresponsereceived&bnkact=fail

6. Click on the Create button to finish creating the payment source.

Once the payment source moves from a status of ‘Pending’ to ‘Active’ in the Website/Apps list, it’s ready to use. This should take no longer than 24 hours.

Step 2: Integrate with your e-commerce store

To start using Viva Wallet as the payment gateway within VirtueMart 2:

1. Find the ZIP archive (vm2_plugin_vivawallet.zip) you downloaded earlier to your desktop.

2. Install through Joomla extension manager (Install).

3. Activate the VM - Payment, Vivawallet plugin through Joomla extension manager (Manage).

4. Add the new payment method (Virtuemart/Shop/Payment Methods) and set parameters / configuration.

Step 3: Set an optional webhook

1. Go to Settings > API Access > Webhooks in the Viva Wallet banking app:
   
   
   

2. Click on Create Webhook.
   The New Webhook dialog box is displayed:
   
   

3. In the Url field, enter
   http(s)://(www.)your_domain.com/index.php?option=com_virtuemart&view=pluginresponse&task=pluginresponsereceived&bnkact=webhook
   exchanging the placeholder for your actual domain name.

4. Choose Transaction Payment Created from the Event Type dropdown.

5. Click on the Save button.