Installation




Before installing the extension, please make sure to Backup your web directory and store database


You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.

Root Directory is - "app/code/magedelight/#YourExtensionName#"

  • Unzip the extension package file into the root folder of your Magento 2 installation.
  • Connect to SSH console of your server:
    • Navigate to the root folder of your Magento 2 setup
    • Run command as per below sequence,

      php bin/magento setup:upgrade

      php bin/magento setup:di:compile

      php bin/magento setup:static-content:deploy

      php bin/magento cache:clean

  • log out from the backend and log in again


If you are using Magento 2.3 or later then you do not need to activate license. Extension will be activated with silent activation mechanism and does not require activation keys to be entered manually.   


Installation with Composer


Composer repository using this command:

composer config repositories.magedelight-repo composer https://packages.magedelight.com/


Replace repo public key and private key with your public and private key

composer config http-basic.gitlab.magedelight.com $PUBLIC_KEY $PRIVATE_KEY


composer require mage_delight/referafriend_module

composer require hyva-themes/magento2-hyva-magedelight-referafriend


To obtain your public and private keys, please navigate to the "My Account" section. In the "Download Extension Packages" tab, you will find the keys available for your access.

Backend Configuration (Admin side)



FieldDescription
Enable Module

Enables or disables the Refer a Friend module for the selected store view. When set to Yes,

the referral program functionality becomes active and customers can participate in the

program. When set to No, all referral features are disabled.

Minimum Withdrawal Amount

Defines the minimum commission balance required for an affiliate to submit a withdrawal

request. Affiliates will not be able to request payouts until their available balance reaches

or exceeds this amount.

Coupon Usage Limit

Specifies the maximum number of times a generated referral coupon code can be used.

Once this limit is reached, the coupon will no longer be valid for new purchases.

Coupon Description

Provides an internal description for referral coupons generated by the Refer a Friend program.

This description helps administrators identify the purpose of the coupon within the Magento

admin panel.

Coupon Priority

Determines the priority level of the referral coupon when multiple cart price rules are applied.

Magento processes rules based on priority values, with lower numbers typically processed first.

Release Period (Days)

Specifies the number of days the commission will remain on hold before becoming available for

withdrawal. This holding period helps ensure the order is completed and not refunded or cancelled

before the commission is released.

Add Affiliate Type Options

Allows administrators to define different affiliate types or partner categories. Each entry consists of

an Affiliate Code (system identifier) and an Affiliate Label (display name shown to users).

Affiliate Code

A unique system identifier used to represent a specific affiliate type or category within the program.

This value is typically used internally by the module.

Affiliate Label

The user-friendly name associated with the affiliate type. This label is displayed in the admin panel

and helps administrators easily identify different affiliate groups or partner types.

Action (Delete Icon)Allows administrators to remove an existing affiliate type option from the configuration list.
AddAdds a new row to define another affiliate type option with a corresponding code and label.

FieldDescription
Program Benefits

Allows the administrator to define and display the advantages of joining the Refer a Friend

program. The content entered here is shown to potential affiliates or participants to explain the

benefits of participating in the referral program, such as earning commissions, sharing referral

links, or accessing promotional materials.

Refer A Friend Rules

Used to specify the rules and guidelines for participating in the Refer a Friend program.

Administrators can outline how referrals work, eligibility requirements, and any restrictions that

participants must follow to qualify for referral rewards or commissions.

Terms & Conditions

Enables the administrator to provide the official terms and conditions for the referral program.

This information is displayed on the affiliate dashboard and during the affiliate application process.

Participants must review and accept these terms before joining the program.

Withdrawal Notice

Allows the administrator to display important information related to withdrawal requests. This may

include minimum payout amounts, processing times, supported payment methods, and other

instructions that affiliates should follow when requesting commission payouts. The notice appears

on the withdrawal request form.

Transaction Notice

Provides informational messages related to referral transactions and commission tracking. The content

entered here is displayed on the transaction page in the affiliate dashboard to help affiliates understand

how commissions are recorded, processed, or updated based on order status.

FieldDescription
Discount Percentage

Specifies the percentage discount applied to orders placed by referred customers. When a

customer uses a valid referral link or coupon code, the configured percentage discount will

be applied to eligible products during checkout.

Eligible Product Categories

Allows the administrator to select the product categories for which the referral discount will

be applicable. Only products that belong to the selected categories will qualify for the referral

discount when a referral code is used.

Eligible Customer Groups

Defines which customer groups are allowed to receive the referral discount. The discount will

be applied only when the customer placing the order belongs to one of the selected customer groups.

FieldDescription
Commission Percentage

Defines the percentage commission that referrers will earn for successful referral purchases.

When a referred customer completes an eligible order, the configured percentage of the

order amount is calculated as commission and credited to the referrer’s account.

Eligible Order Statuses

Allows the administrator to select the order statuses that qualify for commission accrual.

Commission will only be generated when the referred order reaches one of the selected

statuses (for example, Processing or Complete). This ensures commissions are awarded only

for valid and confirmed transactions.

FieldDescription
Available Payment Methods

Allows the administrator to select the payment methods that affiliates can use when

requesting commission withdrawals. Only the selected methods will be available to affiliates

on the withdrawal request form. This helps administrators control how commission payouts

are processed, such as via PayPal, Bank Transfer, or UPI Payment.

FieldDescription
Enable Email Notifications

Enables or disables all email notifications related to the Refer a Friend module. When set to

Yes, the system sends email notifications based on the configured templates. When set to

No, all module-related email notifications are disabled.

Email Sender

Specifies the sender identity used for all referral-related email notifications. The selected

sender determines the name and email address displayed in outgoing emails.

Admin Notification Email

Defines the email address where administrative notifications related to the referral program

will be sent, such as new affiliate enrollment requests or withdrawal requests.

Admin Affiliate Request Template

Selects the email template used to notify the administrator when a new affiliate enrollment

request is submitted by a customer.

Enable Affiliate Emails

Enables or disables email notifications sent to affiliates regarding program-related events

such as enrollment status updates.

Enrollment Request Template

Specifies the email template used to acknowledge that an affiliate enrollment request has

been submitted. This email is sent to the customer after they apply to join the referral program.

Enrollment Approval Template

Defines the email template used to notify a customer when their affiliate enrollment request

has been approved.

Enrollment Rejection Template

Specifies the email template used to inform a customer that their affiliate enrollment request

has been rejected.

Enable Transaction Emails

Enables or disables email notifications related to referral transactions, such as when a new

commission is recorded.

Transaction Status Template

Selects the email template used to notify affiliates when a new transaction or commission

is recorded in their account.

Transaction Reject Template

Specifies the email template used to notify affiliates if a transaction or commission is

rejected or invalidated.

Withdrawal Admin Notification Template

Defines the email template used to notify the administrator when a withdrawal request

is submitted or updated.

Enable Withdrawal EmailsEnables or disables email notifications related to withdrawal requests for affiliates.
Withdrawal Status Update Template

Specifies the email template used to notify affiliates about updates to their withdrawal

request status, such as approval or rejection.

Backend Functionality


Enrolled Affiliates-Grid View

FieldDescription
Add New Affiliate

Allows the administrator to manually create and enroll a new affiliate in the referral program.

Clicking this button opens a form where the administrator can enter affiliate details.

Search by Keyword

Provides a quick search option to locate affiliates by entering keywords such as email address,

referral code, or customer information.

Filters

Enables advanced filtering of affiliate records based on specific criteria such as status, referral

code, or creation date.

Default View

Displays the current grid view configuration. Administrators can switch between saved views

if available.

ColumnsAllows the administrator to customize which columns are displayed in the affiliates grid.
ActionsProvides bulk action options that can be applied to selected affiliate records.
IDDisplays the unique identifier assigned to the affiliate record within the system.
Customer IDShows the Magento customer ID associated with the affiliate account.
Customer EmailDisplays the email address of the customer who has enrolled as an affiliate.
Affiliate Type

Indicates the category or type assigned to the affiliate, such as Developer, Partner, or other

configured affiliate types.

Referral Code

Displays the unique referral code assigned to the affiliate. This code is used by referred

customers to receive referral discounts and track commissions.

Status

Shows the current status of the affiliate account (for example, Approved, Pending, or Rejected).

Only approved affiliates are allowed to participate in the referral program.

Total EarnedDisplays the total commission amount earned by the affiliate from successful referrals.
Current Balance

Shows the amount currently available in the affiliate’s balance that may be eligible for

withdrawal.

CreatedIndicates the date and time when the affiliate account was created.
UpdatedDisplays the most recent date and time when the affiliate record was updated.
Action (Select)

Provides a dropdown menu with available actions for the affiliate record.

View

Opens the affiliate details page where administrators can review affiliate information, financial

data, transaction history, and withdrawal history.

Reject

Allows the administrator to reject the affiliate account, preventing the user from participating

in the referral program.

Delete

Permanently removes the affiliate record from the referral program.

The Enrolled Affiliates grid provides administrators with a centralized interface to manage affiliate accounts, monitor referral performance, and perform administrative actions such as viewing details, rejecting applications, or removing affiliates from the program.

Affiliate Details Page

  • When an administrator clicks View, the system opens the Affiliate Details Page, which displays the complete information related to the selected affiliate.

General Information

FieldDescription
Affiliate IDDisplays the unique identifier assigned to the affiliate account within the referral system.
CustomerShows the Magento customer associated with the affiliate account.
EmailDisplays the email address of the affiliate customer.
Referral Code

Displays the unique referral code assigned to the affiliate. This code is used by referred

customers to receive referral discounts and track commissions.

Status

Indicates the current affiliate status (for example, Approved or Rejected). Only approved

affiliates can participate in the referral program.

Type

Displays the affiliate category or type assigned to the user

(for example, Developer, Employer, Partner, etc.).

Created AtShows the date and time when the affiliate account was initially created.
Last UpdatedDisplays the most recent date and time when the affiliate record was updated.


Financial Information

FieldDescription
Total Earnings

Displays the total commission amount earned by the affiliate through successful referral

transactions.

Total Paid

Shows the total amount that has already been paid to the affiliate through completed

withdrawal requests.

Current Balance

Displays the commission balance currently available for the affiliate. This amount may

be eligible for withdrawal depending on withdrawal rules.

Commission RateShows the commission percentage applied to referral orders for the affiliate.
Payment DetailsDisplays the payment information provided by the affiliate for withdrawal processing.

Transaction History

FieldDescription
IDDisplays the unique identifier for the commission transaction.
Order IDShows the Magento order ID associated with the referral transaction.
AmountDisplays the commission amount generated from the referral order.
Status

Indicates the status of the commission transaction (for example, Confirmed,

Released, or Pending).

CreatedShows the date and time when the commission transaction was created.
Action

Allows administrators to view detailed information about the specific

transaction.

View All TransactionsOpens the complete list of commission transactions associated with the affiliate.

Add New Affiliates

  • The New Affiliate page allows administrators to manually create and enroll an affiliate account for an existing Magento customer.
FieldDescription
Customer Email

Specifies the email address of an existing Magento customer who will be enrolled as an affiliate.

Only registered customer email addresses are accepted.

Affiliate Type

Selects the category or role assigned to the affiliate. Affiliate types are configured in the module

settings and may represent different partner categories such as Developer, Partner, or Influencer.

Profile Link

Defines the affiliate’s profile or promotional website URL. This link can represent the affiliate’s

website, social media profile, or promotional page used to share referral links.

Referral Code

Displays the unique referral code assigned to the affiliate. This code is used by referred customers

to receive referral discounts and generate commissions for the affiliate.

Status

Determines the current status of the affiliate account. Possible values typically include Pending,

Approved, or Rejected. Only approved affiliates are eligible to participate in the referral program.

Save AffiliateSaves the affiliate record and enrolls the selected customer into the referral program.
BackReturns the administrator to the Enrolled Affiliates grid without saving the affiliate record.

Transactions-Grid View

  • The Transactions page lists all referral commission transactions generated from affiliate referrals. Administrators can review order details, commission amounts, and manage transaction statuses.
FieldDescription
Search by Keyword

Allows administrators to quickly search transaction records using keywords such as

affiliate name, email, order ID, or referral information.

Filters

Provides advanced filtering options to narrow down transaction results based on

specific criteria such as affiliate, status, or date.

Default View

Displays the current grid layout configuration. Administrators can switch between

saved grid views if multiple views are available.

Columns

Allows administrators to customize which columns are displayed in the transactions

grid.

Actions (Bulk Actions)

Enables administrators to apply actions to multiple selected transaction records at

once.

IDDisplays the unique identifier assigned to the transaction record.
Affiliate IDShows the unique identifier of the affiliate who generated the referral transaction.
Affiliate NameDisplays the name of the affiliate who referred the customer.
Affiliate EmailShows the email address associated with the affiliate account.
Referred Customer ID

Displays the Magento customer ID of the customer who made the purchase

through the referral.

Referred Customer EmailShows the email address of the referred customer who placed the order.
Order IDDisplays the Magento order number associated with the referral transaction.
Order AmountShows the total value of the order placed by the referred customer.
CommissionDisplays the commission amount earned by the affiliate for the referral order.
Commission %

Indicates the commission percentage applied to the referral order when calculating

the commission amount.

Status

Shows the current status of the transaction, such as Confirmed, Pending, or

Released, depending on the commission processing workflow.

Release Date

Displays the date and time when the commission becomes available for

withdrawal based on the configured commission release period.

CreatedIndicates the date and time when the transaction record was created in the system.
Action (Select)Provides a dropdown menu containing available actions for the transaction record.
View

Opens the transaction details page where administrators can review detailed

information about the referral transaction.

Cancel

Allows the administrator to cancel the transaction. When canceled, the associated

commission will not be credited to the affiliate account.

The Transactions grid enables administrators to monitor referral-generated sales, track commission calculations, and manage the lifecycle of affiliate commission transactions.

Referral Transaction Details

  • The Referral Transaction Details page allows the administrator to review complete information about a specific referral commission transaction. This page provides details about the transaction, the related order, and the affiliate associated with the referral. Administrators can use this page to verify commission calculations, review order information, and track affiliate earnings generated from referred purchases.

Transaction Information

FieldDescription
Transaction IDDisplays the unique identifier assigned to the referral transaction in the system.
Affiliate

Shows the affiliate associated with the referral transaction. The affiliate name links

to the affiliate profile for quick access.

EmailDisplays the email address of the affiliate who earned the commission.
Order

Displays the order number associated with the referral transaction. The order ID links

to the corresponding order details in the system.

Order Amount For CommissionShows the order amount used for calculating the affiliate commission.
Commission AmountDisplays the commission earned by the affiliate from the referred order.
Commission Percentage

Indicates the commission rate applied to the order to calculate the affiliate

commission.

Status

Displays the current status of the referral transaction (for example, Pending,

Confirmed, or Released).

Created AtShows the date and time when the referral transaction was generated in the system.
Last UpdatedDisplays the most recent date and time when the transaction details were updated.


Order Information

FieldDescription
Order ID

Displays the unique order number associated with the referral

transaction.

Order DateShows the date and time when the order was placed.
Order Status

Displays the current status of the order (for example, Complete

, Processing, or Canceled).

Order Grand Total

Shows the total value of the order including taxes, shipping, and

other applicable charges.

Commission Applied on Overall Amount

Displays the amount used as the base for calculating the affiliate

commission.

Customer Name

Shows the name of the customer who placed the order through

the referral.

Customer Email

Displays the email address of the referred customer who completed

the purchase.


Affiliate Information

FieldDescription
Affiliate IDDisplays the unique identifier assigned to the affiliate account.
CustomerShows the name of the customer associated with the affiliate account.
Referral Code

Displays the unique referral code used by the affiliate to generate referral links

and coupon codes.

Status

Indicates the current status of the affiliate account (for example, Approved or

Pending).

Total EarningsDisplays the total commission earned by the affiliate from all referral transactions.
Current BalanceShows the current commission balance available for withdrawal by the affiliate.
Commission RateDisplays the commission percentage assigned to the affiliate for referral transactions.

Withdrawal Requests-Grid View

  • The Withdrawal Requests page displays all withdrawal requests submitted by affiliates. Administrators can review payout details, monitor request status, and manage withdrawal processing.
FieldDescription
Actions (Bulk Actions)Enables administrators to apply actions to multiple withdrawal requests simultaneously.
IDDisplays the unique identifier assigned to the withdrawal request.
Affiliate IDShows the unique identifier of the affiliate who submitted the withdrawal request.
Affiliate NameDisplays the name of the affiliate requesting the withdrawal.
AmountIndicates the commission amount requested for withdrawal by the affiliate.
Payment Method

Displays the selected payment method used for the withdrawal request (for example,

PayPal, Bank Transfer, or UPI).

Status

Shows the current status of the withdrawal request, such as Pending, Approved,

Processed, or Rejected.

Requested On

Displays the date and time when the withdrawal request was submitted by the

affiliate.

Last Updated

Shows the most recent date and time when the withdrawal request status was

updated.

Action (Select)

Provides a dropdown menu with available actions that administrators can

perform on the withdrawal request.

View

Opens the withdrawal request details page where administrators can review

complete payout information.

Reject

Allows the administrator to reject the withdrawal request. If rejected, the

requested amount is returned to the affiliate’s balance.

The Withdrawal Requests grid enables administrators to manage affiliate payouts, review withdrawal requests, and ensure commissions are processed according to the configured payout policies.

Withdrawal Request Review and Processing

The Withdrawal Request Details page allows the administrator to review a specific affiliate withdrawal request and take appropriate action such as processing or rejecting the payout. This page displays detailed information about the request, the affiliate who submitted it, and the payment details required to complete the transaction.

Withdrawal Request Information

FieldDescription
Affiliate

Displays the affiliate associated with the withdrawal request. The affiliate name links to the

affiliate profile for quick reference.

EmailShows the email address of the affiliate who submitted the withdrawal request.
AmountDisplays the amount requested for withdrawal by the affiliate.
Payment Method

Indicates the selected payment method used for the withdrawal request (e.g., PayPal,

Bank Transfer, or UPI Payment).

Payment Details

Shows the payment information submitted by the affiliate based on the selected

payment method.

Status

Displays the current status of the withdrawal request (e.g., Requested, Processed,

or Rejected).

Requested OnShows the date and time when the affiliate submitted the withdrawal request.
Last UpdatedDisplays the most recent date and time when the withdrawal request was updated.
Payment FeesDisplays any processing fees applied to the withdrawal request, if configured.

Affiliate Information

FieldDescription
Affiliate IDDisplays the unique identifier assigned to the affiliate.
CustomerShows the customer name associated with the affiliate account.
EmailDisplays the registered email address of the affiliate.
Referral Code

Shows the unique referral code assigned to the affiliate for sharing referral links

and coupons.

Current BalanceDisplays the affiliate’s current commission balance available in the system.
Total EarningsShows the total commissions earned by the affiliate from all referral transactions.
Created OnIndicates the date when the affiliate account was created.

Admin Comment Form

FieldDescription
Admin Notes

Allows the administrator to add comments related to the withdrawal request. These notes

may include processing details or the reason for rejecting the request.

Available Actions

ActionDescription
Process WithdrawalMarks the withdrawal request as processed after the payout has been completed.
Reject Withdrawal

Rejects the withdrawal request if it does not meet the payout requirements or contains

invalid payment details.

BackReturns to the Withdrawal Requests listing page without making changes.

Frontend Functionality


Refer a Friend –  My Account

The Refer a Friend page is available in the My Account section of the storefront and allows registered customers to join the store’s referral or affiliate program. This page provides customers with an overview of the program and allows them to submit a request to participate.

Key aspects of the page include:

  • Program Introduction – The page provides a brief overview of the referral program, explaining that customers can earn rewards or commissions by referring new customers to the store.

  • Participation Information – Customers can review general information about how the referral program works before submitting their application.

  • Affiliate Application – If the customer is not already enrolled in the program, an Apply Now button is displayed, allowing them to submit a request to become an affiliate.

  • Application Approval Process – After submitting the request, the application may be automatically approved or reviewed by the store administrator, depending on the configuration of the referral program.

  • Access to Affiliate Features – Once the application is approved, the customer gains access to the affiliate dashboard, where they can manage their referral activities.

  • Referral Management – Approved affiliates can use their dashboard to track referral performance, view earned commissions, and manage withdrawal requests.

This page acts as the entry point for customers to join the referral program, providing essential information and enabling them to apply directly from their account.

Affiliate Application Page

After clicking the Apply Now button on the Refer a Friend dashboard, customers are redirected to the Affiliate Application page. This page allows customers to submit their request to join the referral program by providing the required information. The submitted details help the store administrator verify the applicant before granting affiliate access.

Key elements of this page include:

  • Affiliate Type Selection
    Customers must select their Affiliate Type from the available options configured by the administrator. This helps categorize affiliates based on their role, such as developer, marketer, influencer, or partner.

  • Profile Link Submission
    Customers are required to provide a Profile Link, which may include their website, blog, professional profile, or social media page. This information helps the administrator understand how the affiliate plans to promote the store.

  • Personalized Referral Code
    Customers must enter a unique referral code that will be used to generate their referral links and referral coupon codes. This code allows the system to track purchases made through the affiliate’s promotions.

  • Program Terms and Conditions
    The page displays the referral program terms that affiliates must agree to before submitting their application. These terms outline the rules and policies governing the referral program.

  • Application Submission
    After completing the required fields, customers can click the Submit Application button to send their request for review. The application will then be processed according to the store’s approval settings.

  • Navigation Option
    A Back to Dashboard link is available, allowing users to return to the Refer a Friend dashboard without submitting the application.

This page enables customers to formally apply for the referral program and provides the necessary details required for administrator approval and affiliate account activation.

Affiliate Dashboard

Once a customer submits the affiliate application and it is approved by the administrator, the Refer a Friend Dashboard becomes available in the My Account → Refer a Friend section. This dashboard provides affiliates with an overview of their referral activity, earnings, and commission performance.

The dashboard displays summarized information to help affiliates track their referral program performance and manage their earnings.

Key sections of the dashboard include:

  • Affiliate Information
    This section displays the basic affiliate details, including the Affiliate Type, the profile link submitted during application, and the unique referral code assigned to the affiliate. It also shows the configured commission rate and the discount percentage offered to referred customers.

  • Earning Information
    Affiliates can monitor their earnings through this section. It displays the current available balance, earnings for the current month, and the total commission earned from all successful referrals.

  • Withdrawals Information
    This section provides an overview of withdrawal activity. Affiliates can view the total amount withdrawn and the amount currently available for withdrawal based on released commissions.

  • Purchase Count / Referral Activity
    This area shows a summary of referral transactions, including the total number of referral transactions, transactions currently in progress, and released transactions where commissions have been confirmed.

  • Share Referral Code
    The dashboard displays the affiliate’s unique referral code, which can be shared with friends or customers. Affiliates can easily copy the code and use it in referral links or promotional activities to track purchases made through their referrals.

  • Program Terms Reminder
    The dashboard may also display the referral program terms and conditions as a reminder of the program policies and participation rules.

  • Quick Actions
    At the bottom of the page, affiliates can access quick action buttons such as:

    • View My Transactions – Allows affiliates to view detailed records of referral transactions and commissions.

    • Manage Withdrawals – Enables affiliates to submit withdrawal requests and manage payout activities.

This dashboard acts as the central control panel for affiliates, allowing them to track their referral performance, monitor commissions, and manage withdrawals within their customer account.

Referral Transactions Page

When the affiliate clicks the View My Transactions button from the Refer a Friend dashboard, they are redirected to the Referral Transactions page. This page allows affiliates to monitor all commissions generated through their referral activities and track the status of each referral transaction.

The page provides a detailed overview of referral-based orders and the commissions earned from those purchases.

Key features of this page include:

  • Transaction Notice
    At the top of the page, a notice explains how referral commissions are processed. It informs affiliates that commissions are recorded when a referred customer places an order and that the commission status may remain pending until the order is completed or confirmed.

  • Referral Transaction List
    The page displays a list of all referral transactions generated through the affiliate’s referral code or referral link. Each transaction represents a purchase made by a referred customer.

  • Transaction Details
    For each referral transaction, the following information is displayed:

    • Date – The date when the referral transaction was recorded.

    • Referee Customer – The referred customer's name (partially masked for privacy).

    • Commission Amount – The commission earned from the referral purchase.

    • Commission Percentage – The commission rate applied to the order.

    • Release Date – The date when the commission becomes eligible for withdrawal after the configured release period.

    • Status – Displays the current transaction status, such as Confirmed or Released.

  • Total Approved Commission
    At the bottom of the transaction list, affiliates can see the total approved commission amount, which represents the total earnings from completed and approved referral transactions.

  • Navigation Options

    • Back to Dashboard – Allows affiliates to return to the main Refer a Friend dashboard.

    • Manage Withdrawals – Redirects affiliates to the withdrawal management page, where they can request payouts for available commissions.

This page enables affiliates to track the performance of their referrals, monitor commission earnings, and review the status of each referral transaction directly from their customer account

Withdrawals Management Page

When the affiliate clicks the Manage Withdrawals button from the Refer a Friend dashboard or transaction page, they are redirected to the Withdrawals Management page. This page allows affiliates to manage their commission payouts and submit withdrawal requests for the commissions they have earned through successful referrals.

The page provides a clear overview of the affiliate’s available balance and their withdrawal request history.

Key features of this page include:

  • Current Balance
    The page displays the affiliate’s current available commission balance, which represents the amount that can be requested for withdrawal based on released commissions.

  • Request Withdrawal
    Affiliates can click the Request Withdrawal button to submit a payout request. The request will be processed according to the payment methods and withdrawal rules configured by the store administrator.

  • Withdrawal Request History
    A list of all submitted withdrawal requests is displayed, allowing affiliates to track their payout activity and view the details of each request.

  • Withdrawal Details
    For each withdrawal request, the following information is shown:

    • Request Date – The date when the withdrawal request was submitted.

    • Request Amount – The amount requested for withdrawal.

    • Payment Processing Fees – Any applicable processing fees associated with the payout.

    • Released Amount – The amount approved for payout after processing.

    • Payment Method – The payment method selected for the withdrawal, such as PayPal or bank transfer.

    • Processed Date – The date when the withdrawal request was processed.

    • Status – Displays the current status of the request, such as Pending, Processed, or Rejected.

  • Navigation Options
    The page also provides navigation options such as:

    • Back to Dashboard – Returns the affiliate to the main Refer a Friend dashboard.

    • View Transactions – Redirects the affiliate to the referral transactions page to review commission details.

This page enables affiliates to monitor their payout history, request withdrawals, and track the status of their commission payouts directly from their customer account.

Request Withdrawal Through (PayPal)

When the affiliate clicks the Request Withdrawal button on the Withdrawals Management page, a Request Withdrawal form appears. This form allows affiliates to request a payout for the commission balance available in their account.

Affiliates must provide the required details to submit the withdrawal request. Once the request is submitted, it will be reviewed and processed by the store administrator according to the configured withdrawal rules.

Key elements of the Request Withdrawal form include:

  • Withdrawal Amount
    Affiliates must enter the amount they want to withdraw from their available commission balance. The amount must meet the minimum withdrawal limit configured by the administrator.

  • Withdraw Full Balance Option
    Affiliates can choose to withdraw their entire available balance by selecting the provided option. This automatically fills the maximum withdrawable amount available in their account.

  • Available Balance Information
    The form displays the maximum available balance along with the minimum withdrawal amount, helping affiliates ensure the request meets the payout requirements.

  • Payment Method (PayPal)
    The withdrawal payment is processed using PayPal. Affiliates must select PayPal as the payment method to receive the payout.

  • PayPal Account ID
    Affiliates must enter their PayPal ID or PayPal email address associated with their PayPal account. This information is used by the administrator to process the withdrawal payment.

  • Withdrawal Notice
    The form also displays important withdrawal guidelines such as minimum withdrawal limits, processing time, and instructions to ensure correct payment details are provided.

  • Submit Request
    After completing the required fields, affiliates can click Submit Request to send the withdrawal request to the administrator for processing.

  • Cancel Option
    The Cancel button allows affiliates to close the withdrawal form without submitting the request.

This form enables affiliates to securely request commission payouts via PayPal while ensuring the required payment details and withdrawal conditions are met.

Request Withdrawal (Bank Transfer)

When the affiliate selects Bank Transfer as the payment method in the Request Withdrawal form, additional fields are displayed to collect the necessary banking details required to process the payout. This option allows affiliates to receive their commission payments directly to their bank account.

Affiliates must provide accurate banking information to ensure that the withdrawal request can be processed successfully by the store administrator.

Key elements of the Bank Transfer withdrawal request include:

  • Withdrawal Amount
    Affiliates must enter the amount they wish to withdraw from their available commission balance. The amount must satisfy the minimum withdrawal limit configured by the administrator.

  • Withdraw Full Balance Option
    Affiliates can select the option to withdraw the entire available balance, which automatically fills the maximum amount eligible for withdrawal.

  • Payment Method (Bank Transfer)
    Affiliates must select Bank Transfer as the payment method to receive their payout directly to their bank account.

  • Account Holder Name
    The name of the bank account holder to whom the withdrawal payment will be issued.

  • Account Number
    The bank account number where the payout should be transferred.

  • IFSC Code
    The bank IFSC code used to identify the specific bank branch for the transfer.

  • Bank Name
    The name of the bank where the affiliate’s account is registered.

  • Branch Name
    The branch name associated with the provided bank account. This field may be optional depending on configuration.

  • Additional Information
    Affiliates can provide any extra details related to the bank transfer if required.

  • Withdrawal Notice
    The page also displays important withdrawal guidelines, such as minimum withdrawal limits, processing time, and supported payment methods.

  • Submit Request
    After entering all required bank details, affiliates can click Submit Request to send the withdrawal request to the administrator for processing.

  • Cancel Option
    The Cancel button allows affiliates to close the withdrawal form without submitting the request.

This form enables affiliates to securely request commission payouts via bank transfer by providing the required banking information for payment processing.

Request Withdrawal (UPI Payment)

When the affiliate selects UPI Payment as the withdrawal method in the Request Withdrawal form, the system displays fields required to process the payout through the UPI (Unified Payments Interface) system. This option allows affiliates to receive their commission payouts directly through a UPI-enabled payment account.

Affiliates must provide accurate UPI details to ensure the withdrawal request can be processed successfully by the store administrator.

Key elements of the UPI withdrawal request include:

  • Withdrawal Amount
    Affiliates must enter the amount they wish to withdraw from their available commission balance. The entered amount must meet the minimum withdrawal amount configured by the administrator.

  • Withdraw Full Balance Option
    Affiliates can select the option to withdraw the full available balance, which automatically fills the maximum withdrawable amount available in their account.

  • Payment Method (UPI Payment)
    Affiliates must select UPI Payment as the payout method to receive their commission through a UPI-supported payment service.

  • UPI ID
    Affiliates must enter their UPI ID associated with their payment account. This ID is used by the administrator to transfer the withdrawal amount to the affiliate’s account.

  • Withdrawal Notice
    The form also displays important withdrawal guidelines, including the minimum withdrawal limit, supported payment methods, and estimated processing time.

  • Submit Request
    After entering the required details, affiliates can click Submit Request to send the withdrawal request to the administrator for processing.

  • Cancel Option
    The Cancel button allows affiliates to close the withdrawal form without submitting the request.

This form enables affiliates to request commission payouts via UPI by providing their UPI payment ID for secure and direct fund transfers.

Withdrawal Request Submission

After an affiliate submits the withdrawal request through the Request Withdrawal form, the system processes the request and displays a confirmation message indicating that the withdrawal request has been successfully submitted.

Once the request is submitted, the following actions occur:

  • Success Notification
    A confirmation message is displayed at the top of the page informing the affiliate that the withdrawal request has been successfully submitted.

  • Withdrawal Record Created
    A new withdrawal entry is automatically generated in the Withdrawals Management section. This record contains the details of the submitted request.

  • Withdrawal Request Details Displayed
    The newly created request appears in the withdrawal history table with information such as:

    • Request Date – The date when the withdrawal request was submitted.

    • Request Amount – The amount requested for withdrawal.

    • Payment Processing Fees – Any applicable processing charges.

    • Released Amount – The amount approved for payout.

    • Payment Method – The selected payout method (for example, PayPal, Bank Transfer, or UPI).

    • Processed Date – The date when the payout is processed by the administrator.

    • Status – Displays the current state of the request.

  • Withdrawal Status Tracking
    The withdrawal request will initially appear with the status Requested, indicating that the payout request is pending review by the administrator.

  • Administrator Processing
    After the administrator reviews the request, the status may change to Processed once the payment has been completed.

This process allows affiliates to track the status of their withdrawal requests and maintain a record of all payout transactions within their Refer a Friend account dashboard.

Applying Referral Coupon at Checkout

Affiliates participating in the Refer a Friend program receive a unique referral code that can be shared with friends or customers. This referral code can be applied during checkout as a discount coupon, allowing the referred customer to receive a predefined discount while the affiliate earns a commission from the purchase.

When placing an order, the referred customer can enter the referral code in the Apply Discount Code section during checkout.

Key aspects of referral coupon usage include:

  • Applying the Referral Code
    During the checkout process, the customer can enter the affiliate’s referral code in the Apply Discount Code field before placing the order.

  • Successful Coupon Application
    Once the code is applied successfully, a confirmation message is displayed indicating that the coupon has been applied to the order.

  • Discount Display in Order Summary
    The applied referral coupon appears in the Order Summary section as a discount line item. The label displays the message “Discount (Coupon Code By [Affiliate Name])”, indicating that the discount was applied using an affiliate referral code.

  • Automatic Discount Calculation
    The system automatically calculates the discount based on the configured referral discount percentage and applies it to the cart total.

  • Affiliate Commission Tracking
    When the order is successfully placed using the referral coupon, the system records the referral transaction and calculates the commission for the affiliate according to the configured commission rules.

  • Order Completion Requirement
    The affiliate commission is credited only after the referred order reaches the eligible order status defined in the referral program configuration.

This functionality enables the referral program to connect affiliate promotion with customer discounts, ensuring that affiliates are rewarded whenever their referral code is used during the checkout process.

Demo


Click here to visit frontend.

Click here to visit backend admin panel.

FAQs


Click here to visit FAQs.

Support


Click here to raise a support ticket using your MageDelight account.

Additional Services


Click here to get the customized solution for this extension.



Thank you for choosing MageDelight!



  • No labels