Installation and setup

Requirements

• CS-Cart or Multi-Vendor 4.17.2 or later (Ultimate editions included).
• Administrator access to the store’s admin panel.
• A Riverty merchant account. Riverty issues one X-Auth-Key per web shop and per country: the test keys come from the Riverty Merchant Portal for the Partner Test environment (you can register there yourself), the live keys are issued by Riverty after their onboarding (contract and checks). Riverty’s own steps decide how long that takes; the add-on cannot speed it up.
• A cron job on your server (see step 7).
• For notifications from Riverty (optional): a public HTTPS address of your store. Ask your Riverty implementation manager to send the checkout events to the webhook address of the Connection page and to give you the shared secret. The add-on also works without events: it reads the order back from Riverty after the customer returns and on every cron run.

Install the add-on

1. Download the kv_riverty-<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 Riverty for CS-Cart and Multi-Vendor 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 Riverty

1. Open Orders > Riverty and the Connection tab (or the add-on settings and click Connection).
2. Choose Test mode and paste the test key of every country you sell to (Germany, Austria, Switzerland, Netherlands, Belgium, Sweden, Norway, Finland, Denmark). Leave the other countries empty. Save and click Test connection: each stored key is checked with Riverty’s version call; a green message means every key works. A key Riverty rejects (401) pauses the add-on until you save a correct key.
3. Enter the Riverty merchant ID if you sell to Sweden, Norway, Finland, Denmark or Belgium (Dutch): Riverty’s terms links of those countries contain it. Without it the method is hidden for those countries.
4. Optional: the webhook secret you got from Riverty (test and live differ), and an order number prefix when two shops share one Riverty key (Riverty never accepts the same order number twice per key).
5. Switch to Live mode only after a successful test, enter the live keys and test again.
6. Open Administration > Payment methods, add a method, choose the processor Riverty and set its Riverty payment type to Invoice; activate it. The other types are not verified with Riverty and stay hidden at checkout unless you switch on Enable payment types not verified with Riverty after Riverty confirmed them (see Configuration).
7. Add the cron job from the settings page (Cron section), every minute is fine. Overlapping runs are prevented. The cron job reads pending authorizations back, repeats captures whose answer was lost and runs the status-triggered capture, void and refund.

What to set in the add-on settings

• Capture when the order status becomes: the status that means “shipped” (default Complete). Riverty sends the invoice to the customer at capture.
• Void the reservation when the order status becomes (default Canceled) and Refund when the order status becomes (default empty).
• Order status when Riverty accepts (default Open).

Multi-Vendor

By default the marketplace owner connects one account for all vendors (Marketplace owner mode on): the owner is the seller of record, the cart is authorized once, and each vendor’s order captures that vendor’s own lines when the vendor moves it to the capture status. Switch the mode off to let each vendor connect their own Riverty account in the vendor panel.

Update

1. Upload the new package the same way. Your settings, keys 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 keys and the local record of reservations, captures and refunds (Riverty keeps its own records, and the order history of CS-Cart is not touched). Reservations that are still open at Riverty lapse after 30 days: capture or void them first, and refund what needs refunding, because after an uninstall the add-on no longer knows the invoice numbers a refund refers to.