The Viva Wallet plugin for osCommerce 2 enables you to receive payments to osCommerce 2 via the Viva Wallet payment gateway.
- Log in to the Viva Wallet banking app, demo or live .
- Find your Merchant ID and API Key.
- Download API-master.zip to your desktop.
Adding the Viva Wallet plugin to osCommerce consists of the following steps.
Step 1: Create a payment source
To add a new payment source in the Viva Wallet banking app:
- Click on Sales in the left navigation:
Click on Online payments in the Sales menu.
Click on Websites / apps in the Online payments menu:
Click on the Add Website/App button in the top right-hand corner:
The New Payment Source dialog box is displayed:
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
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
- Failure URL – enter
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 osCommerce 2:
Unzip the archive (
API-master.zip) you downloaded earlier.
Open the directory (
API-master/Plugins/oscommerce/vivawallet/includes) containing the source files.
Copy the files to their corresponding location on the server.
Enable the payment module in admin / modules / payment and specify a unique sort order.
Edit the module settings to the required values.
Step 3: Set an optional webhook
Go to Settings > API Access > Webhooks in the Viva Wallet banking app:
Click on Create Webhook.
The New Webhook dialog box is displayed:
In the Url field, enter
http(s)://(www.)your_domain.com/checkout_process.php?act=vivawallet&status=webhook, exchanging the placeholder for your actual domain name.
Choose Transaction Payment Created from the Event Type dropdown.
Click on the Save button.