CS-Cart 4
Our plugin for CS-Cart 4 enables you to receive payments to your CS-Cart shopping cart via the Viva Wallet payment gateway.
Before you start
Before you begin:
- Log in to Viva Wallet, demo or live , and select the required account.
- Find your Merchant ID and API Key.
- Download API-master.zip to your desktop.
Setup instructions
Adding the Viva Wallet plugin to CS-Cart 4 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
[(www.)yourdomain.com]
, nothttp://[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 –
[success_url]
as described in the plugin instructions. - Failure URL –
[failure_url]
as described in the plugin instructions. - Checkboxes – read the information against each one and select them all.
Click on the Create button to finish creating the payment source.
Step 2: Integrate with your e-commerce store
To start using Viva Wallet as the payment gateway within CSCart 4:
1 – Unzip the archive (API-master.zip
) you downloaded earlier.
2 – Open the directory (API-master/Plugins/cscart/cscart4-vivawallet
) containing the source files.
3 – Upload the files from the package.
4 – Back up your database and execute following sql statements (with phpmyadmin for example):
INSERT INTO `cscart_payment_processors` (`processor`, `processor_script`, `processor_template`, `admin_template`, `callback`, `type`) VALUES
('Viva Payments', 'vivawallet.php', 'views/orders/components/payments/vivawallet.tpl', 'vivawallet.tpl', 'N', 'P');
INSERT INTO `cscart_language_values` (`lang_code` ,`name` ,`value`) VALUES
('en', 'vivawallet_instalments', 'Instalments');
INSERT INTO `cscart_language_values` (`lang_code` ,`name` ,`value`) VALUES
('en', 'vivawallet_no_instalments', 'No Instalments');
INSERT INTO `cscart_language_values` (`lang_code` ,`name` ,`value`) VALUES
('en', 'vivawallet_instalments_step', 'Instalment steps');
INSERT INTO `cscart_language_values` (`lang_code` ,`name` ,`value`) VALUES
('en', 'vivawallet_instalments_start', 'First instalment');
INSERT INTO `cscart_language_values` (`lang_code` ,`name` ,`value`) VALUES
('en', 'vivawallet_transaction_fail', 'Transaction failed or has been cancelled.');
INSERT INTO `cscart_language_values` (`lang_code` ,`name` ,`value`) VALUES
('en', 'text_vivawallet_notice', '<b>Note:</b> Please set the following information to payment source:<br />Success URL: <u>[success_url]</u><br /> Fail URL: <u>[failure_url]</u><br /><br />'),
('el', 'text_vivawallet_notice', '<b>Note:</b> Please set the following information to payment source:<br />Success URL: <u>[success_url]</u><br /> Fail URL: <u>[failure_url]</u><br /><br />');
DROP TABLE IF EXISTS `vivawalletdata`;
CREATE TABLE IF NOT EXISTS `vivawalletdata` (
`hp_id` int(11) NOT NULL AUTO_INCREMENT,
`hp_oid` int(11) NOT NULL,
`hp_code` varchar(150) DEFAULT NULL,
PRIMARY KEY (`hp_id`)
) ENGINE=InnoDB;
5 – Copy the files to your store root (no files are overwritten).
6 – Add a the new payment method through your store admin area:
Select from dropdown template vivawallet.tpl
Select from dropdown processor Viva Payments
Select payment category Internet Payments
Add a title
In the configure tab, specify an instalment logic (optional)
7 – Save the settings.