Getting Started

Welcome to the Store Credit & Refund Documentation.

Here, you will find everything you need to set up Store Credit and create a flexible policy for crediting and quick refunding.

Our extension allows you to convert customers' returns into store credit. Each order that opted for a refund can be easily turned to a special deposit on the customer's balance, and immediately used for shopping.

Go ahead, dive in!

Firstly, please, find our extension in the My Downloadable Products section of our store. Learn how to install extension, and proceed with the Quick Start, which will guide you through setting up your crediting and refunding policy.

How to install the extension

How to install the extension Back up your store database and web directory. Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store. Copy the installation instructions from the page My Downloadable Products to...

Quick Start

Quick Start Our Store Credit & Refund extension for M2 is a simple yet powerful extension that allows customers to build complex policies with minimal effort. Most of its functions work out-of-box, and once you've installed it, you can refund your ord...

Store Credit Settings

Store Credit Settings This section describes all settings that you can use for configuring your crediting and refunding policy. They are located at Sales -> Store Credit -> Settings and divided into the following subsections: General Settings Store...

Customers' Balances

Customers' Balances Customers' Balance Grid All customers' balances can be seen in one place, using the Sales -> Store Credit -> Customers grid. The grid contains the following information: Customer Name - customer name. Customer Email - customer e...

Transactions

Transactions All Store Credit transactions are located in the Sales -> Store Credit -> Transactions section. Each of them provides the following information: Transaction # - ID of the transaction. Customer Name - the name of the customer, to whom t...

Earning Rules

Earning Rules The Earning Rules allow you to award customers for placing an order with an additional monetary amount, which will go directly to his/her account and can be used immediately on the next placed order. It is a powerful promotional tool that ca...

Credit product

Credit product Credit Products are special types of products that allow customers to deposit or refill funds in their balances. They consist of two types: Credit Products - allows customers to deposit money to the Store Credit balance at a price. Refill ...

Reports

Reports Our extension allows you to generate reports about the Store Credit operations. It only provides general statistics, which can be seen at Sales -> Store Credit -> Reports. The Report can be generated for the following time periods: Day Week...

How-To

How-To This section describes the most common issues and their solution, consisting of the following subsections: Customizing Email Template for Store Credit Balance Update Customizing Email Template for Store Credit Balance Update. Go to Marketing -&...

Command Line Interface

Command Line Interface Usage: php -f ./bin/magento [options] mirasvit:credit:import-export --export - export all customer' balances to the export.csv file mirasvit:credit:import-export --import --file import.csv - import customer' balances from the impor...

GraphQL Objects Reference

GraphQL Objects Reference Cart object . The Cart object can contain the following attributes: Attribute Data Type Description credit CartCredit Store credit information for cart CartCredit object Defines store credit information for cart The Car...

How to upgrade extension

How to upgrade extension To upgrade the extension, take the following steps: Back up your store database and web directory. Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store. Run the command composer requi...

Disabling Extension

Disabling Extension Temporary Disabling To temporarily disable the extension, please take the following steps: Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store. Run the command php -f bin/magento module:d...

Change Log

Change Log 1.1.11 (2021-02-26) Fixed Issue when the row total in the backend is negative for items without tax 1.1.10 (2020-12-09) Fixed Added composer dependencies for module-report Button 'Send Credit to Friend' is not blocked after submitting and c...