Process OpenPix withdraw transactions

Author: rennerocha

thebook/webhooks/management/commands/fetch_openpix_transactions.py

@@ -10,7 +10,7 @@ class Command(BaseCommand):
 
     def handle(self, *args, **options):
         """If we miss some webhook payload, this command should ensure that we don't lose any transaction"""
-        end_date = datetime.date.today()
+        end_date = datetime.date.today() + datetime.timedelta(days=1)
         start_date = end_date - datetime.timedelta(days=2)
 
         transactions = fetch_transactions(start_date, end_date)

thebook/webhooks/models.py

@@ -67,14 +67,15 @@ def process(self, bank_account=None, user=None):
             self.save()
             return
 
-        if jmespath.search("event", payload) != "OPENPIX:TRANSACTION_RECEIVED":
+        transaction_type = jmespath.search("event", payload)
+        if transaction_type != "OPENPIX:TRANSACTION_RECEIVED":
             self.status = ProcessingStatus.UNPARSABLE
             self.internal_notes = "webhooks.paypal.unparsable_event"
             self.save()
             return
 
         amount = jmespath.search("pix.charge.value || pix.value", payload) / 100
-        openpix_fee = calculate_openpix_fee(amount)
+        openpix_fee = calculate_openpix_fee(amount, transaction_type)
 
         # Original in UTC time
         paid_at = jmespath.search("pix.charge.paidAt || pix.time", payload)

thebook/webhooks/openpix/services.py

@@ -10,11 +10,16 @@
 from thebook.bookkeeping.models import BankAccount, Category, Transaction
 
 
-def calculate_openpix_fee(amount):
-    """OpenPix doesn't provide the fee in the Webhook payload so we need to calculate it based on the amount received and the active account plan"""
+def calculate_openpix_fee(amount, transaction_type):
+    """
+    OpenPix doesn't provide the fee in the Webhook payload so we need to calculate it based
+    on the amount received, the active account plan and the type of the transaction
+    """
     fee = 0.0
 
-    if settings.OPENPIX_PLAN == "FIXO":
+    if transaction_type == "WITHDRAW":
+        fee = -1
+    elif settings.OPENPIX_PLAN == "FIXO":
         fee = -0.85
     elif settings.OPENPIX_PLAN == "PERCENTUAL":
         fee = -1 * round(min(max(0.008 * amount, 0.5), 5), 2)
@@ -68,6 +73,7 @@ def fetch_transactions(start_date: datetime.date, end_date: datetime.date):
             transaction_description = (
                 f"Transferência entre contas bancárias - {transaction_id}"
             )
+            transaction_amount = -1 * transaction_amount
         else:
             transaction_category = None
             payer_name = jmespath.search("payer.name", transaction) or ""
@@ -86,19 +92,20 @@ def fetch_transactions(start_date: datetime.date, end_date: datetime.date):
             )
         )
 
-        if not is_bank_account_transfer:
-            transaction_fee_amount = calculate_openpix_fee(transaction_amount)
-
-            results.append(
-                Transaction(
-                    reference=f"{transaction_id}-T",
-                    date=transaction_date,
-                    description=f"Taxa OpenPix - {transaction_description}",
-                    amount=transaction_fee_amount,
-                    bank_account=bank_account,
-                    category=bank_fee_category,
-                    created_by=user,
-                )
+        transaction_fee_amount = calculate_openpix_fee(
+            transaction_amount, transaction_type
+        )
+
+        results.append(
+            Transaction(
+                reference=f"{transaction_id}-T",
+                date=transaction_date,
+                description=f"Taxa OpenPix - {transaction_description}",
+                amount=transaction_fee_amount,
+                bank_account=bank_account,
+                category=bank_fee_category,
+                created_by=user,
             )
+        )
 
     return results

thebook/webhooks/tests/openpix/test_calculate_openpix_fee.py

@@ -6,24 +6,28 @@
 
 
 @pytest.mark.parametrize(
-    "openpix_plan,amount,expected_fee",
+    "openpix_plan,transaction_type,amount,expected_fee",
     [
-        ("PERCENTUAL", 20, -0.5),
-        ("PERCENTUAL", 62.5, -0.5),
-        ("PERCENTUAL", 64, -0.51),
-        ("PERCENTUAL", 100, -0.8),
-        ("PERCENTUAL", 625, -5),
-        ("PERCENTUAL", 630, -5),
-        ("FIXO", 20, -0.85),
-        ("FIXO", 62.50, -0.85),
-        ("FIXO", 64, -0.85),
-        ("FIXO", 100, -0.85),
-        ("FIXO", 625, -0.85),
-        ("FIXO", 630, -0.85),
+        ("PERCENTUAL", "OPENPIX:TRANSACTION_RECEIVED", 20, -0.5),
+        ("PERCENTUAL", "PAYMENT", 62.5, -0.5),
+        ("PERCENTUAL", "PAYMENT", 64, -0.51),
+        ("PERCENTUAL", "PAYMENT", 100, -0.8),
+        ("PERCENTUAL", "PAYMENT", 625, -5),
+        ("PERCENTUAL", "PAYMENT", 630, -5),
+        ("FIXO", "OPENPIX:TRANSACTION_RECEIVED", 20, -0.85),
+        ("FIXO", "PAYMENT", 62.50, -0.85),
+        ("FIXO", "PAYMENT", 64, -0.85),
+        ("FIXO", "PAYMENT", 100, -0.85),
+        ("FIXO", "PAYMENT", 625, -0.85),
+        ("FIXO", "PAYMENT", 630, -0.85),
+        ("PERCENTUAL", "WITHDRAW", 630, -1),
+        ("FIXO", "WITHDRAW", 630, -1),
     ],
 )
 def test_calculate_openpix_fee_based_on_selected_plan(
-    settings, openpix_plan, amount, expected_fee
+    settings, openpix_plan, transaction_type, amount, expected_fee
 ):
     settings.OPENPIX_PLAN = openpix_plan
-    assert calculate_openpix_fee(amount) == round(Decimal(expected_fee), 2)
+    assert calculate_openpix_fee(amount, transaction_type) == round(
+        Decimal(expected_fee), 2
+    )

thebook/webhooks/tests/openpix/test_services__fetch_transactions.py

@@ -65,6 +65,18 @@ def openpix_fetch_transactions__one_transaction():
         return payload.read()
 
 
+@pytest.fixture
+def openpix_fetch_transactions__withdraw_transaction():
+    with open(
+        Path(
+            SAMPLE_PAYLOADS_DIR
+            / "openpix_fetch_transactions__withdraw_transaction.json"
+        ),
+        "r",
+    ) as payload:
+        return payload.read()
+
+
 @responses.activate
 def test_fetch_multiple_transactions(
     db,
@@ -87,7 +99,7 @@ def test_fetch_multiple_transactions(
         start_date=datetime.date(2026, 2, 1), end_date=datetime.date(2026, 2, 28)
     )
 
-    assert len(transactions) == 5
+    assert len(transactions) == 6
 
     assert transactions[0].reference == "01KH7WTFXGGFDSJKHFKJSDHGDG"
     assert transactions[0].date == datetime.date(2026, 2, 15)
@@ -111,27 +123,38 @@ def test_fetch_multiple_transactions(
         transactions[2].description
         == "Transferência entre contas bancárias - E54811417202602091301r0gglTvTqLN"
     )
-    assert transactions[2].amount == Decimal("511.87")
+    assert transactions[2].amount == Decimal("-511.87")
     assert transactions[2].bank_account == openpix_bank_account
     assert transactions[2].category == bank_account_transfer_category
     assert transactions[2].created_by == user
 
-    assert transactions[3].reference == "MTBQL"
-    assert transactions[3].date == datetime.date(2026, 2, 28)
-    assert transactions[3].description == "LUIZ ANTONIO - 12345678910"
-    assert transactions[3].amount == Decimal("42")
+    assert transactions[3].reference == "E54811417202602091301r0gglTvTqLN-T"
+    assert transactions[3].date == datetime.date(2026, 2, 20)
+    assert (
+        transactions[3].description
+        == "Taxa OpenPix - Transferência entre contas bancárias - E54811417202602091301r0gglTvTqLN"
+    )
+    assert transactions[3].amount == Decimal("-1")
     assert transactions[3].bank_account == openpix_bank_account
-    assert transactions[3].category == None
+    assert transactions[3].category == bank_fee_category
     assert transactions[3].created_by == user
 
-    assert transactions[4].reference == "MTBQL-T"
+    assert transactions[4].reference == "MTBQL"
     assert transactions[4].date == datetime.date(2026, 2, 28)
-    assert transactions[4].description == "Taxa OpenPix - LUIZ ANTONIO - 12345678910"
-    assert transactions[4].amount == Decimal("-0.50")
+    assert transactions[4].description == "LUIZ ANTONIO - 12345678910"
+    assert transactions[4].amount == Decimal("42")
     assert transactions[4].bank_account == openpix_bank_account
-    assert transactions[4].category == bank_fee_category
+    assert transactions[4].category == None
     assert transactions[4].created_by == user
 
+    assert transactions[5].reference == "MTBQL-T"
+    assert transactions[5].date == datetime.date(2026, 2, 28)
+    assert transactions[5].description == "Taxa OpenPix - LUIZ ANTONIO - 12345678910"
+    assert transactions[5].amount == Decimal("-0.50")
+    assert transactions[5].bank_account == openpix_bank_account
+    assert transactions[5].category == bank_fee_category
+    assert transactions[5].created_by == user
+
 
 @responses.activate
 def test_fetch_already_existing_transactions(
@@ -199,3 +222,48 @@ def test_do_not_return_webhook_processed_transactions(
     )
 
     assert len(transactions) == 0
+
+
+@responses.activate
+def test_fetch_withdraw_transaction(
+    db,
+    openpix_fetch_transactions__withdraw_transaction,
+    openpix_bank_account,
+    bank_account_transfer_category,
+    bank_fee_category,
+    user,
+):
+    responses.add(
+        responses.GET,
+        f"{settings.OPENPIX_API_BASE_URL}/api/v1/transaction",
+        body=openpix_fetch_transactions__withdraw_transaction,
+        content_type="application/json",
+    )
+
+    transactions = fetch_transactions(
+        start_date=datetime.date(2026, 2, 1), end_date=datetime.date(2026, 2, 28)
+    )
+
+    assert len(transactions) == 2
+
+    assert transactions[0].reference == "E54811417202602091301r0gglTvTqLN"
+    assert transactions[0].date == datetime.date(2026, 2, 20)
+    assert (
+        transactions[0].description
+        == "Transferência entre contas bancárias - E54811417202602091301r0gglTvTqLN"
+    )
+    assert transactions[0].amount == Decimal("-511.87")
+    assert transactions[0].bank_account == openpix_bank_account
+    assert transactions[0].category == bank_account_transfer_category
+    assert transactions[0].created_by == user
+
+    assert transactions[1].reference == "E54811417202602091301r0gglTvTqLN-T"
+    assert transactions[1].date == datetime.date(2026, 2, 20)
+    assert (
+        transactions[1].description
+        == "Taxa OpenPix - Transferência entre contas bancárias - E54811417202602091301r0gglTvTqLN"
+    )
+    assert transactions[1].amount == Decimal("-1")
+    assert transactions[1].bank_account == openpix_bank_account
+    assert transactions[1].category == bank_fee_category
+    assert transactions[1].created_by == user