Installation and setup

Requirements

• CS-Cart and Multi-Vendor 4.17.2 or later.
• Administrator access to the store’s admin panel.
• A Tpay merchant account with API access. In the Tpay merchant panel create an Open API key (Integration > API > Open API Keys > Add new key) and copy the client ID and secret; the merchant ID and the security code are in the panel too (Notifications > Security). Test with a sandbox account (register.sandbox.tpay.com).
• A cron job on your server (see step 6).

Install the add-on

1. Download the kv_tpay-<version>.zip package from your Kavio Labs or CS-Cart Marketplace account.
2. In the admin panel, open Add-ons > Manage add-ons.
3. Click the gear button and choose Manual installation, then upload the archive.
4. Find Tpay Payments in the list and make sure its status is Active.
5. Enter your license key under Settings > License (Kavio Labs downloads) and click Check now.

Connect Tpay

1. Open Orders > Tpay (the add-on page) and the Connection tab, or Add-ons > Manage add-ons > Tpay Payments > Settings and click Connection.
2. Choose Test mode and enter the sandbox client ID and secret, the security code and the merchant ID. Save and click Test connection: a green message (it also names the number of payment groups of the account) means the credentials work.
3. The notification address is sent with every transaction (callbacks.notification.url). In the Tpay panel (Settings > Notifications) the option Allow override must be on, or the same address entered there. It must be reachable from the internet over HTTPS (TLS 1.2), without redirects: Tpay does not follow 301 / 302.
4. Switch to Live mode and enter the live credentials only after a successful test; test again.
5. Open Administration > Payment methods, add a method, choose the processor Tpay and activate it.
6. Add the cron job from the settings page (Cron section), every minute is fine. Overlapping runs are prevented.

Multi-Vendor

By default the marketplace owner connects one account for all vendors (Marketplace owner mode on). Switch it off to let each vendor connect their own Tpay account in the vendor panel (Connection tab).

Update

1. Upload the new package the same way. Your settings, credentials and data are kept.
2. The add-on adds missing tables and settings by itself on the first request after the update.

See CHANGELOG for what changed in each version.

Uninstall

Open Add-ons > Manage add-ons, click the add-on’s gear button and choose Uninstall. This removes the add-on’s settings, language variables and database tables, including the stored credentials.