Configuration

Open Add-ons → Manage add-ons → Store Credit Wallet → Settings. The settings apply to the whole installation (all storefronts).

Paying with store credit

Setting	Description
Enable the store credit wallet	Master switch. Off: customers cannot use store credit and earn no cashback; existing orders, refunds and the history keep working.
Customers can pay with store credit at checkout	Shows the store credit block at checkout.
Highest share of an order total payable with store credit (%)	100 = an order can be paid fully with store credit. Lower values leave a part for the payment method.
Store credit can pay shipping costs	Off: store credit pays products, taxes and fees, but not the shipping cost.

Cashback

Setting	Description
Give cashback	Uses the rules in Marketing → Cashback rules.
Credit cashback when the order reaches	Order statuses that add pending cashback to the wallet. Default: Complete.
When several rules match	Give the highest cashback (default) or add them up.
Earn cashback on the part paid with store credit	Off (recommended): only the part paid with money earns cashback.
Cashback expires after (days, 0 = never)	Expiry of each cashback credit.
Show “Cashback you will earn” at checkout	Shows the expected cashback in the order summary.

Cashback rules

Marketing → Cashback rules → +:

• Cashback: a percent of the eligible amount, or a fixed amount per order (never more than the eligible amount).
• Applies to: the whole order or products in the selected categories (optionally with subcategories).
• Minimum order subtotal, maximum cashback per order, user groups (none = all customers), valid from / to and position.
• In CS-Cart (multi-storefront) a rule created in a storefront applies to that storefront; rules created in “All stores” apply everywhere.

The eligible amount is the products after order discounts, without shipping, taxes, payment surcharges, gift certificates and top-up products, and (by default) without the part paid with store credit.

Cancellations and refunds

Setting	Description
Return the store credit used for an order when it reaches	Default: Canceled, Declined, Failed. Also reverses credited cashback and top-ups of that order.
Refund the paid amount of a paid order to store credit when it reaches	Optional, empty by default. Only orders that were paid (a status with “payment received”) are refunded, minus earlier refunds.
Return store credit of unpaid “Incomplete” orders after (hours)	A customer who leaves the payment page leaves an “Incomplete” order. After this time its store credit returns; if the order is paid later, the credit is taken again. 0 = never.

Top-ups

Off by default. Store credit from refunds, cashback and your own credits is a discount instrument of your store. When customers pay money into a balance, the balance can count as stored value or electronic money in some countries, with licensing, safeguarding and refund rules. Check the rules that apply to your business before you enable top-ups.

Setting	Description
Let customers buy store credit (top-up products)	Turns top-ups on.
Top-up product IDs	Comma-separated product IDs. Price × quantity of these products is credited to the buyer. Use products without taxes and shipping (for example a downloadable product “Store credit $50”).
Credit top-ups when the order reaches	Empty = every status that means “payment received”.

Orders with a top-up cannot be paid with store credit and earn no cashback.

E-mails

Setting	Description
E-mail customers when store credit is added	Refunds, cashback, top-ups, returned credit and your credits.
E-mail customers when store credit is deducted, reversed or expires	Your deductions, cashback and top-up reversals, expiry.
Remind customers before credit expires (days, 0 = off)	One reminder per expiring credit.

Edit the texts in Design → E-mail templates (Store credit changed, Store credit expires soon). When you add or deduct credit by hand, the form has its own “E-mail the customer” option.

Vendors (Multi-Vendor)

Like gift certificates, the vendor order amount used for payouts is the order total after store credit. See Usage → Multi-Vendor.

Schedule

Setting	Description
Run the schedule on admin activity when no cron job is set up	Runs at most once an hour after an admin page has been sent.
Cron key	Secret key of the cron URL, generated at installation.
Cron job	The command and URL to run hourly.

php /path/to/store/admin.php --dispatch=kv_customer_wallet.cron

or call https://yourstore.com/index.php?dispatch=kv_customer_wallet.cron&key=<cron key> hourly.

License

The license status is shown in a License card at the top of the add-on page, above the tabs, so you see it on every tab. The License tab holds the key itself. The key is stored once for the whole installation.

The License card shows:

• the status in color: green when valid, blue for a development host or the 14-day period before a key is required (with the days left), amber when the license server could not be reached (with the days left) or a Marketplace number is still being verified, red when the add-on is switched off;
• in plain words what the status means and, when the add-on is (or will be) switched off, what stops: customers can no longer pay with store credit and no new cashback is earned; balances, history, refunds to the wallet and admin credits keep working;
• the licensed domain, every storefront with its result (covered, development host, not covered), the end of the updates and support period, the last and the next check, and the key in use (masked);
• the actions Enter license key / Change license key (opens the License tab), Check now (verifies at once and stays on the page), Manage license (your licenses on cs-cart.kaviolabs.com) and, without a valid license, Buy a license.

In Add-ons → Manage add-ons the add-on’s row shows a small license badge next to its name, for example License: Valid or License: Pending · 9 days left.

The add-on’s own admin pages (store credit wallets, a customer’s wallet, transactions, cashback rules) show the license status in a bar at the top: a small green chip when the license is valid, or a banner with the status, what is switched off and the same actions as the card.

Setting	Description
License key	Your Kavio Labs license key (KAVIO-XXXX-XXXX-XXXX-XXXX, from My licenses on cs-cart.kaviolabs.com) or your CS-Cart Marketplace license number. If you entered the Marketplace license number in Add-ons → Manage add-ons (the add-on’s license field), leave this empty: the add-on uses that number.
License status	Points to the License card and explains what the check sends.

What the license covers. A license is bound to the base domain you entered at purchase (for example yourstore.com) and covers every subdomain of it (www.yourstore.com, shop.yourstore.com, staging.yourstore.com). Local development hosts are always allowed: localhost, 127.0.0.1 and other private IP addresses, and host names ending in .localhost, .test, .local, .example or .invalid. A store on a different base domain needs its own license. If you move your store to a new domain, contact support.

When the add-on checks. When you save the key, and then once a day. The check runs only in the admin panel (on a page you open) or from cron, never while customers browse the storefront or place orders, and takes a few seconds at most. A cron job keeps the license verified even when nobody opens the admin panel:

php /path/to/store/admin.php --dispatch=kv_customer_wallet_license.check

What is sent. The check sends this to https://cs-cart.kaviolabs.com and nothing else: the license key, the add-on ID and version, the host names of your storefronts, your CS-Cart version and edition, and a random one-time value. No customer or order data is sent. The server answers with a digitally signed result, so a forged answer is ignored.

Statuses.

Status (card)	Color	What happens
Valid	Green	The license is valid for this domain. Everything works.
Development host	Blue	The store runs on a local development host, which every license covers. Everything works.
Pending verification	Amber	A CS-Cart Marketplace license number was accepted, but the Marketplace has not confirmed it yet. Everything works.
Pending · N days left	Blue	No verified key yet (a new installation). Everything works for 14 days.
Grace period · N days left	Amber	The last checks failed (for example a network problem). The add-on keeps working for 14 days after the first failed check.
Not activated, Invalid key, Revoked, Domain mismatch, Not verified	Red	Customers can no longer pay with store credit (the checkout block is hidden) and new orders earn no cashback. Everything that already exists keeps working: balances, the account page and history, cancelled orders giving their credit back, pending cashback of earlier orders, top-ups of paid orders, expiry, refunds to the wallet, your credits and deductions, reports, CSV and the REST API. An order edited in the admin panel keeps (at most) the store credit it already uses. Domain mismatch shows the licensed domain next to the domain your store runs on.

When your updates and support period ends, the add-on keeps working. Only updates and support stop.

License information appears in the admin panel only, and only for administrators who may manage add-ons; vendors and customers never see it. When the add-on is switched off, other admin pages also show a notice once per session with a link to the add-on page; the add-on page and the add-on’s own pages show the card or the status bar instead.