Magento 2 Wallet System
Table of Content
Introduction
Magento 2 Wallet Extension is an awesome module that allows the customers to make the online payment from their Wallet System.
The customers can select the Wallet System payment method at the time of the checkout process.
Now the buyers can easily add credit amounts, transfer money, view transaction details in Wallet System.
Moreover, the admin can set the minimum and maximum limits for adding money to the wallet. The admin can also do a refund to its customer using the wallet money.
Please Note:
- At the time of adding balance to the wallet, no other product should be added in the shopping cart.
- During the checkout, if the total payable amount exceeds the wallet balance, the customer can pay the remaining amount only using other payment methods like COD, check/money order, bank transfer, PayPal, and Stripe payment methods.
- For partial online 3rd party payment method support, contact sales.
- This module works with Multiple Address Checkout.
-
This module supports multi-store and multi-currency features.
-
The currency which admin has assign to the respective store, user can add the amount in that same currency to the wallet and proceed for check out.
-
Whenever a user looks in a default store view, he will see the currency in which the admin has assigned it.
Watch the these videos to understand the module workflow: –
Admin Configuration
Customer End
Admin Adding Amount into the Wallet
Wallet to Wallet Transfer
Advanced Features
- Email notification is sent to the customer for each transaction.
- The wallet amount will get credited after the generation of the invoice.
- The cashback amount gets deducted from the Customer’s Wallet after the admin creates the credit memo for the refund.
- The codes are open source, so it can be customized as per the requirement.
Admin Centric Features
- Merchant can view the bank account details during the bank transfer approval.
- The owner will receive a notification to approve the payee and to approve the amount transfer to the account.
- Also, the admin can restrict the approval required for payees.
- The store Owner can restrict the customer to use discount codes when adding the amount in his wallet.
- Admin can export wallet system details in CSV and XML format.
- The admin can bulk adjust the wallet amount for customers using a CSV file.
- The owner can also do a refund with the help of the Wallet System for Adobe Commerce.
- Admin can add the amount to the Customer’s Wallet or deduct the amount from the Customer’s Wallet.
- The owner can create multiple Credit Rules for the cashback.
- Also, the admin can view the customer details who are using Wallet System for making the online payment.
- Merchant can set the limit ( maximum and minimum ) for the Wallet Amount.
- Admin can enter the prefix for various wallet transactions.
- The store owner & the customers can view detailed transaction information.
- Merchant can approve or disapprove of the bank transfer status.
- The owner can transfer money from one wallet to another customer’s wallet.
- This extension is compatible with GraphQL.
- The extension is compatible with the Hyva Theme.
Customer-Centric Features
- The buyer can easily add credit amount into their wallet system.
- Also, the shopper can add a payee in his account to transfer the amount in his wallet.
- The customer can add multiple bank account details.
- The consumer can request the bank account deletion.
- Moreover, the shopper can request to transfer their amount in his bank account.
- On the checkout page, the customer can see used wallet amount and remaining wallet amount.
- The cashback amount gets deducted from the Customer’s Wallet after the admin creates the credit memo for the refund.
- Moreover, the buyer can get Cash Back amount into their Wallet.
- Shoppers can receive monthly statements regarding wallet transactions via email.
- Also, the customer can add a payee within his account to transfer the amount to the payee’s wallet.
Wallet System Installation
Customers will get a zip folder and they have to extract the contents of this zip folder on their system. The extracted folder has an src folder, inside the src folder you have the app folder.
Now, You need to transfer this app folder into the Adobe Commerce Cloud root directory on the server as shown below.
After the successful installation, you have to run these commands in the Adobe Commerce root directory.
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:flush
php bin/magento queue:consumers:start bulkadjust.amount &
php bin/magento queue:consumers:start bulkadjust.amount.csv &
Configuration For Multilingual Support
For the multilingual support, the admin will navigate through Store->Configuration->General ->Locale Options furthermore select the locale as German
(the language into which the admin wants to translate his store content).
Wallet System – Module Translation
If the user wants to translate their module from English to German,
they need to follow the path app/code/Webkul/Walletsystem/i18n in their unzipped Adobe Commerce Walletsystem folder and will get a CSV file with name “en_US.csv”.
Now, they will rename that CSV as “de_DE.csv” and translate all right side content after the comma in the German language.
After editing the CSV, save it and then upload it to the path app/code/Webkul/Walletsystem/i18n where they have installed Adobe Commerce Cloud on the server.
Now, the module will get translated into the German Language. It supports both RTL and LTR languages.
The user can edit the CSV like the image below.
Wallet System – Module Configuration
Post successfully installing the Wallet System module, please go to the backend admin panel to do the module configuration. First, the admin needs to do the configuration in the Payment Method.
Payment Methods Configuration
Now, Follow the path: Stores > Configuration > Sales > Payment Methods > Webkul Wallet System.
Enable this Payment Method – then, select Yes option to use the Wallet System module, else select No.
Payment Method Title – after that enter the title of the Wallet system which will appear on the checkout page.
Minimum Amount to Add in Wallet – then, determine the minimum value of the amount that can be added to the wallet.
Maximum Amount to Add in Wallet – Now define the maximum value of the amount that can be added to the wallet.
Payment from Applicable Countries – Now, choose the applicable countries from the list for the wallet system.
Allow Payment Methods to Add the amount in Wallet – Admin will also select various payment methods that can be used by the customer to make payment while adding Wallet Cash into their Wallet System.
Sort Order – Now, arrange the sorting order of the wallet system payment method.
Wallet System Configuration
For Wallet System Configuration, the admin can follow the path Stores > Configuration >Wallet System. Hence, we have two options –
- Cash Back Calculation Based On – Cart Based or Product Based.
- Price Calculation Based On – Either select Fixed or Percent.
Display Custom Message On Wallet Amount Transfer to Bank Account Request Submission
Furthermore, under this configuration setting the admin will –
- Display Custom Message – The admin will select the option as Yes to display the custom message else select no.
- Message on Transfer Request Submission – The admin will enter the message text. The entered text will display a success message to the customer after transferring the wallet amount to the bank.
Adding Amount In Wallet
Here, the admin will configure –
- Allow using Discount while adding the amount to the wallet –
allow or ban the customers to apply discounts while adding wallet amounts to his wallet.
Transfer Amount Settings
Here, the admin will configure –
- Enable Validation while Transfer – Select Yes and it will send a verification code via Email ID.
- Duration of code usage – Enter the duration in seconds of the validation code. Example: (30).
- Customer Payee Approval Required – now, pick Yes or No for providing approval to the customer payee from admin.
- Display Custom Message – After selecting “yes” to the Display Custom Message option then it will appear on the front end
- Message on payee Request Submission– Message will deliver to the customer.
Now, if you add the payee then you will see the message text as shown below.
Prefix for Transactions –
The admin needs to add the prefix for the following transactions of the Wallet –
- The credited amount by admin.
- The debited amount by admin.
- The amount transferred by the customer.
- Amount transferred to the customer.
- Wallet recharge.
- Used wallet amount.
- Cashback amount.
- Refund of an order.
- Refund of the wallet recharge order.
Cron Job Settings
Enable Cron Job for Monthly Statement – Now, select Yes or No to send or ban monthly statements to customers on registered email id.
Wallet System Transaction Emails
Here, the admin has to select the wallet system transaction emails to send whenever a particular event occurs.
- Wallet Recharge Email Template For Customer – When the customer will recharge the wallet then they will get the Mail.
- Wallet Recharge Email Template For Admin– When the customer will recharge the wallet then the admin will get the Mail.
- Wallet Amount Used Email Template For Customer – After a transaction from the wallet, the customer will receive the mail.
- Wallet amount Used Email Template For Admin– After a transaction from the wallet, the admin will receive the mail.
- Wallet Cashback Amount Email Template For Customer – The customer will receive the mail when he got the cashback amount as per rules set by admin.
- Wallet Cashback Amount Email Template For Admin– The admin will receive the mail when the customer got the cashback amount as per rules set by admin.
- Wallet Amount Refund Email Template For Customer– Customers will receive the mail when they will refund their wallet.
- Wallet Amount Refund Email Template For Admin– Admin will receive the mail when Customers will refund their wallets.
- Order Refund Email Template For Customer– The customer will receive the mail when the order price will refund.
- Order Refund Email Template For Admin– The admin will receive the mail when the order price will refund.
- Admin Credit Amount Email Template For Customer– the customer will receive the mail when the admin will Credit the amount to the customer’s wallet.
-
Admin Credit Amount Email Template For Admin –
The admin will receive the mail when they will credit the amount to the customer’s wallet.
- Admin Debit Amount Email Template For Customer– The customer will receive the mail when the admin will debit the amount to the customer’s wallet then.
- Admin Debit Amount Email Template For Admin– The admin will receive the mail when the admin will debit the amount to the customer’s wallet then.
- Customer Credit Amount Email Template For Customer– The customer will receive the mail when the another user will Credit the amount to the customer’s wallet.
- Customer Credit Amount Email Template For Admin– The admin will receive the mail when another user will Credit the amount to the customer’s wallet.
- Customer Debit Amount Email Template For Customer– The customer will receive the mail when another user will transfer the amount to the customer’s wallet.
- Customer Debit Amount Email Template For Admin – The admin will receive the mail when another user will transfer the amount to the customer’s wallet.
- OTP Email For Transfer Amount To Customer– The customer will receive OTP mail for verification when the customer is transferring the amount to another wallet user.
- Monthly Statement Email Template – The customer will receive the monthly statement mail after cron setup.
- Customer Transfer Amount to Bank Email Template For Admin- The admin will receive the mail when the customer will transfer the wallet amount to the bank.
- Customer Transfer Amount to Bank Email Template For Customer– The customer will receive the mail when he will transfer the wallet amount to the bank.
- Approve Customer Transfer Amount to Bank Email Template For Customer– The customer will receive the mail when the admin will approve the transaction when the customer will transfer the wallet amount to the bank.
Adding Wallet Cash
My Wallet
After the installation of the extension, the customer can see “My Wallet” with two sub-menu options –
- Manage Wallet Amount
- Transfer Wallet Amount
Manage Wallet Amount
Now, clicking the Manage Wallet Amount sub-menu option brings up a section to manage the wallet amount.
Therefore, the customer can also see their total wallet balance, wallet transaction details(credit & debit), can transfer the amount to the bank account.
The customer can also add credit amount into their wallet system by entering the amount into the provided input box and clicking the add money to the wallet button.
Transaction Details
The customers can click the Reference # to view the additional details for the respective wallet transaction.
Add Money To Wallet:
After entering the amount to be added to the wallet, the customer will click on Add Money To Wallet button. This will add the wallet amount to the shopping cart. After that, click on the Proceed to Checkout button as shown below in the snapshot.
Order Summary
On the checkout page, customers can see the Order Summary for wallet recharge. They then select a payment method and click Place Order to complete the purchase.
After the payment is made and the invoice gets generated, the customer can see the credited amount in their wallet system.
Before the invoice generation, the status of the wallet amount is Pending and after the invoice gets generated it changes to Approved as shown below in the snapshot.
Transfer Amount To Bank:
Customers can request the admin to transfer their wallet balance to a bank account. They simply click Transfer Amount to Bank Account and enter the transfer details in the pop-up form.
Here, the admin will enter – the amount to transfer, account details, mention a note, and lastly, click the Submit button to submit the wallet amount transfer request.
The customer can add the bank account in the account details section by selecting from the dropdown.
Account Details
In order to add the account details of the customer, the customer needs to navigate to My Wallet>Add Account Details.
The customer can also request the delete from admin by clicking on the Request delete button as shown in the image below.
Note: As soon as the customer submits the wallet amount transfer request, the amount to be transferred will get deducted from the customer’s wallet.
The admin receives the wallet transfer request in the backend. They can approve it to change the status to Approved or disapprove it by clicking the Disapprove button.
Wallet System Bank Transaction View
If the admin disapproves of the transfer request, this will credit the amount back to the customer’s wallet which was got deducted while submitting the transfer request.
Note: After approving the wallet amount transfer request, the admin will manually and out of the system transfer the amount to the bank using the details shared in the transfer request.
The customer will also be able to check the status of the transfer under their account panel.
Transfer Wallet Money
The customer can transfer his wallet money to another customer’s wallet. To do so, the customer will navigate to My Wallet>Transfer Wallet Amount. Here, the customer will see a list of added payees and can transfer the wallet amount to them easily.
To add a New Payee click the Add Payee button as shown below in the snapshot.
This brings up a pop-up to add the payee details, enter the details, and click the Submit button.
Now, select a customer from the drop-down menu option who will receive the wallet money and then enter the transfer amount. You can even add a small note with this transaction for any reference. Click the Transfer Money to Customer button, and a verification step will appear next (if enabled).
Verification Code
The customer needs to enter the verification code set on the registered email id for validation purposes. After entering the Verification Code, click the Send Amount button to receive transferred wallet money. If you have not received the verification code in your inbox, check the spam folder for the same.
Using Wallet System at Checkout
At the time of making a payment, a customer can use Wallet System to make the order payment. The total payable amount will deduct from the Wallet Amount balance and the customer can also see the remaining Wallet amount after making the payment.
If the total payable amount exceeds the available Wallet balance, then the customer will have the option of making payment for the remaining amount by the other payment method(s) available for that store.
If the wallet balance is low, the customer can simply select any of the available other payment methods.
The partial payment methods information will be visible on the order view page also.
Admin Management – Wallet System
The admin can see the “Wallet System” option and of its sub-menus. Please check the below image for a better understanding.
Let’s go through each of the sub-menu options one by one –
Customer Wallet Details
When the admin will click on “Wallet System Details”, then the admin can see the wallet history(credit & debit) for all of the customers. Here, the admin can see the details like – ID, Modified At, Customer Name, Total Amount, Remaining Amount, Unused Amount, Action(to check the individual details).
Here, clicking on the Individual Details link for a particular customer brings up the details of all the transactions that have been made. To check a particular transaction click the View Transaction Link as shown below in the snapshot.
Wallet System Bank Transaction View
Clicking the View Transaction link brings up the section with complete transaction details of the customer’s individual transaction.
Wallet System Details
The admin can also export wallet system details in a CSV or XML format as required.
Bank Transfer Details
Under this section, the admin will find all the details regarding the bank transfer details like – Reference, Amount, Action, Status, Transaction At, Note, and Action column. Whenever a customer goes to withdraw from his wallet to his bank account.
Allows the admin to get complete bank transfer record details with pending status initially.
Bank Transfer Details
The admin can update the bank transfer transaction status as well.
From here, the admin will select the transactions from the list in which the admin wants to update the transaction status. And then, select either of the status option mentioned below –
- Cancel Transaction – This will disapprove or cancel the transaction.
- Approve Transaction – This will approve the transaction.
The admin can also view the complete details of the transaction.
Wallet System Bank Transaction View
To view the details, simply click the Select link and select the option View Transaction option which displays the transaction details.
From here also, the admin can update the transaction status as per the above image.
Adjust Amount to Wallet
Now, the admin can Enter Amount, select what action they want to perform( Credit or Debit) from “Action want to perform on the amount” and add a note for the transaction.
The admin can select the customer for whom they want to credit or debit the amount from the list of customers with the Customer ID, Name, Email address, Remaining Wallet Amount, Total Wallet Amount, and Adjust Amount.
Adjust Amount for Customer
So, there is a button called “Adjust Amount” for each customer in the list of customers. With the help of this button, the admin can add or deduct the wallet amount from any particular customer.
When the admin clicks there, a pop-up opens where the admin has to enter Amount, and select what action they want to perform ( Credit or Debit). From Action perform on the amount and add a Note for the transaction. Lastly, click the Submit button to credit/debit the amount.
Now, you can see a success message after the transfer as shown below in the snapshot.
Adjust Wallet Amount by CSV file
The admin can upload a CSV file to bulk adjust ( Credit or Debit) the wallet amount for the customers and add a note for the transaction record.
A sample CSV has been attached and the admin is required to fill in some basic details such as customer email, amount to be adjusted, note for the transaction and action to be performed (Debit/Credit).
Once the CSV is imported by the admin, it will show a success message to the admin.
The admin can verify the amount adjustment by checking the same in the Customer Wallet Details section and clicking on the Individual details.
The admin can see the details for the amount credited/debited to customer as seen below
The amount credited/debited to the customer’s wallet by the admin will be visible to the customer under his account.
Wallet System Credit Rules
Wallet Credit Rules are for the efficient management of the Credit Amount process in the Wallet system. From here, the admin can easily create multiple rules for the Wallet Credit and apply them as per the condition. Mainly, there are two types of Credit Rules–
- On Cart.
- On Product.
Furthermore, the admin can see all the details for Wallet system Credit Rules in a grid.
When Credit Rule is based on “On Cart”
Now, the admin can click on the Add New Credit Rule button to add new Credit Rules. The admin can select either “On Cart” or “On Product” for the Credit Rule. The admin can enter Cashback Amount, Minimum Cart/Product Amount, select the Start From Date, select the End Date, and set Rule Status as Enabled or Disabled.
If the admin selects “On Cart” then Credit will get applied to the customer when his order value is greater than the set Minimum Amount for the Cart and if he orders between the dates set by the admin for that particular Cart Rule.
When Credit Rule is based on “On Product”
Here, the admin will go to Product > Catalog and can edit any product. They will see two fields – “Wallet Cash Back” in which the admin will enter the amount which will get credited back to the customer when they buy this particular product.
Also, there is another field called “Product Wallet Credit Amount Based On” in which the admin can either select “Product Credit Amount” or “Cart Rules“. And, if the admin select “Product Credit Amount“, therefore the amount entered for “Wallet Cash Back” will get credited back to the customer after the product purchase.
Add Credit Rule
If the admin selects “Rules Amount” then, the amount entered for Credit Rule Based on Product will be applied. So, please check the below image for the Credit Rule Based on Product.
Now, on the cart page, the customer receives a message of amount getting credited in the Wallet. Also, the credited amount will depend on the Wallet System Cash Back Configuration.
If the “Priority for Cashback” is set as “Cart Base” then Cart Based Credit rules will get applied. furthermore if the “Priority for Cashback” is set as “Product Based” then either Product Based Credit rules or “Product Credit Amount” set for per product will get applied.
The Credited amount is credited to the Customer’s Wallet after order completion.
Wallet System Payee Details
Under this section, the admin can see a list of all the wallet system payee’s details along with their status. Also, the admin can delete or update the payee status as enabled or disabled as required.
Now, to delete a payee, select the payee and then tap on the Actions drops down option and select the delete option.
moreover to update the payee status select the payee and click on the Actions drop-down option and click on Update Payee Status option. After that click enable or disable as required.
Even the admin can also export the wallet system payee details. And, to export, click on the Export link and then select the exported file format as CSV or Excel XML and click Export after that.
Even, the admin also gets the notification for approving the payee. Check the below-given snapshot for further details.
Customer Bank Account Details
Now, The admin can view all the details of the accounts which are added by the customers for the bank transfer. Also, the customer can request the bank detail transfer for deletion.
Even, The deletion request will display furthermore the appropriate action can be taken as shown in the image below.
That’s all for the Wallet System for Magento 2. However, if you still have questions regarding the Magento 2 extensions please create a support ticket by clicking Webkul Support System.