add wise payouts rst

Author: soldatov-ss

docs/index.rst

@@ -15,6 +15,7 @@ Welcome to django-referral-system's documentation!
    promoter
    referral
    referral_service
+   wise_payouts
 
 
 Key Features

docs/referral_service.rst

@@ -101,14 +101,14 @@ The `send_referral_invitation_email` method allows promoters to send an email in
 
 1. **Environment Variables**:
 
-   Make sure to set the following environment variables in your `.env` file before sending referral invitation emails:
+Make sure to set the following environment variables in your `.env` file before sending referral invitation emails:
 
    .. code-block:: bash
 
        BASE_REFERRAL_LINK=
        BASE_EMAIL=
+These variables are necessary for generating the referral link and setting the "from" email address.
 
-    These variables are necessary for generating the referral link and setting the "from" email address.
 
 2. **Correct Template Path**:
 

docs/wise_payouts.rst

@@ -0,0 +1,66 @@
+Wise Payouts
+============
+
+This section explains how the `PromoterPayoutService` handles sending payouts via Wise to eligible promoters.
+
+1. Sending Wise Payouts
+------------------------
+
+The `send_wise_csv_for_promoters_payouts` method is responsible for generating a CSV file for Wise payouts and processing payouts for eligible promoters. It checks which promoters have a balance that meets or exceeds their minimum withdrawal amount and creates payouts for those promoters.
+
+- **Method**: `send_wise_csv_for_promoters_payouts`
+
+.. code-block:: python
+
+    promoter_payout_service.send_wise_csv_for_promoters_payouts()
+
+### Example
+
+Assume a promoter has a balance of $100, which meets or exceeds their minimum withdrawal balance of $50. The system will generate a Wise payout for that promoter and include the following data in the CSV file:
+
+.. code-block:: csv
+
+    name,recipientEmail,amount,sourceCurrency,targetCurrency,amountCurrency,type
+    John Doe,[email protected],100.00,USD,USD,target,EMAIL
+
+### Key Points:
+
+- **Payout Method**: The `payout_method` for these payouts is set to `'wise'`, and the `EMAIL` type is used, meaning payouts are processed based on the recipient’s email address.
+- **Currency**: The payout currency is set to USD by default, but it can be changed by passing additional arguments to the method.
+- **Balance Check**: Only promoters with a balance greater than or equal to their `min_withdrawal_balance` will be included in the payout.
+
+2. CSV Generation
+------------------
+
+The method generates the CSV data for Wise using a pandas DataFrame. The resulting CSV string can be sent to Wise for processing.
+
+### Example CSV Data
+
+.. code-block:: csv
+
+    name,recipientEmail,amount,sourceCurrency,targetCurrency,amountCurrency,type
+    Jane Smith,[email protected],150.00,USD,USD,target,EMAIL
+    John Doe,[email protected],100.00,USD,USD,target,EMAIL
+
+This CSV file contains all the necessary information to process payouts through Wise, ensuring that the correct amount is paid to the corresponding recipient via email.
+
+3. Payout Creation
+-------------------
+
+After generating the payout data, the service automatically creates a payout record for each eligible promoter and marks their pending commissions as paid.
+
+- **Method**: `create_payout`
+
+.. code-block:: python
+
+    promoter_payout_service.create_payout(
+        promoter=promoter_instance,
+        amount=promoter_instance.current_balance,
+        payout_method='wise'
+    )
+
+This method saves a `PromoterPayout` record for each promoter, and any commissions marked as "pending" are updated to "paid".
+
+.. note::
+
+    Ensure that the promoters have a valid payout method (Wise) and that their balance meets the minimum withdrawal requirement to process payouts. The system will skip promoters who do not meet these conditions.

referrals/services/promoter_payout_service.py

@@ -140,14 +140,14 @@ def calculate_commission_amount(amount_paid: int, referral_commission_rate: Deci
         return math.floor(Decimal(price) * commission_rate)
 
     @staticmethod
-    def create_payout(promoter: Promoter, amount: float, payout_method):
+    def create_payout(promoter: Promoter, amount: float, payout_method: str):
         """
         Creates a payout record for a promoter and marks their pending commissions as paid.
 
         Args:
             promoter (Promoter): The promoter receiving the payout.
             amount (float): The payout amount.
-            payout_method (str): The method used for the payout (e.g., 'wise', 'crypto').
+            payout_method (str): The method used for the payout (e.g ., 'wise', 'crypto').
 
         Returns:
             None