Installation and setup

Requirements

• CS-Cart, CS-Cart Ultimate, Multi-Vendor or Multi-Vendor Ultimate 4.17.2 to 4.21.x; PHP 7.4 to 8.3 as your CS-Cart version supports.
• cURL and OpenSSL for PHP; MySQL 5.7 or later, or MariaDB 10.2 or later (the add-on uses nested named locks).
• An HTTPS storefront. The webhook and the return address must be reachable over https:// without a redirect in production.
• A Vipps MobilePay merchant agreement with online payments. In the business portal (portal.vippsmobilepay.com) you find the Merchant Serial Number (MSN) of the sales unit, the client id, the client secret and the subscription key (Ocp-Apim-Subscription-Key). For tests you need the keys of a test sales unit; the test environment is apitest.vipps.no.
• A cron job on your server (step 6). Without it payments are still confirmed by the webhook and the customer’s return, but a lost webhook is not recovered.

Install the add-on

1. Download the kv_vipps_mobilepay-<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 Vipps MobilePay 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 Vipps MobilePay

1. Open Orders > Vipps MobilePay and the Connection tab (or the add-on’s Settings page and the connection block).
2. Choose Test (sandbox) mode. Under the test sales unit enter the Merchant Serial Number (MSN) (4 to 10 digits), the Sales unit currency (NOK, DKK or EUR), the Client id, the Client secret and the Subscription key (Ocp-Apim-Subscription-Key).
3. Click Save and test. “Connection works (test mode).” means the add-on fetched an access token and the sales unit answered. The secrets are stored encrypted and are not shown again; leave a field empty to keep the stored value.
4. Click Register webhook. The add-on registers the address shown on the page with the seven ePayment events and stores the returned secret encrypted. Registering again replaces the registration.
5. Open Administration > Payment methods, add a method, choose the processor Vipps MobilePay, set the name, an icon if you like, the availability and the storefronts, and activate it. Two optional settings are described in Configuration.
6. Add the cron job from the settings page (Cron section): the command line (php admin.php --dispatch=kv_vipps_mobilepay.cron) or the secret web address. Every minute is fine; overlapping runs are prevented.
7. Place a test order, approve it in the Vipps MobilePay test app and check the order’s Vipps MobilePay tab.
8. When the test works, switch the Mode to Live, enter the production MSN, currency and keys under the production sales unit, Save and test, and Register webhook again for the live sales unit.

Multi-Vendor

• Marketplace owner mode (default): the owner connects one sales unit; vendors have no Connection tab. See Configuration.
• Owner mode off: every vendor connects their own sales unit in the vendor panel (Orders > Vipps MobilePay > Connection) and registers their own webhook.

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, the stored credentials, the log and the job queue. The payment records (payments and their captures, refunds and releases) are kept, so after a reinstall the order tab, capture and release work again for reservations that are still open; reconnect the sales unit first. Capture or release open reservations before you remove the add-on for good. To remove the payment records as well, tick Delete payment records on uninstall in the add-on settings before you uninstall (off by default).