Cancel and refund an order with payment provider #930

jonathanreveille · 2024-09-24T17:20:11Z

Purpose

This PR will solve this issue

We want to able to cancel and then refund an order if all conditions are met.
The refund state can only be accessible if the order is canceled, not free and the student has paid at least 1 installment in the payment schedule.

Proposal

Add new state 'refund' in the order flows.
Add endpoint refund for payment backends.
Add admin API endpoint to cancel and refund an order.
Fix debug views for payment and mail reminders for paid installments

We want to be able to refund the installments paid on an order for a student. This state is only accessible when the order is cancelled. Some adjustments were made for the OrderGeneratorFactory to use this new state 'refund' in tests. There will be very few cases where an order can be refund, for example : the session is canceled, the professor is on sick leave, or the admin decides to refund the installments for the student in specific cases.

For now, we have added the refund and cancel action with payment backend Lyra. It allows to refund or cancel a transaction created with the payment provider. The payment provider decides whether the transaction can be cancelled or refunded, depending on the capture date of the amount. For our case, we let the payment provider decide the operation to do, and we create a transaction and a credit note when we receive the notification through our payment webhook. Adjustments were done to set an installment as refunded once we receive the notification from the payment provider.

For admin users, we have created two new endpoints to change the state of an order. The first one is to cancel an order, and once the order is cancelled, the admin user may use the refund endpoint to trigger the refund of all paid installments on an order's payment schedule.

Since we have updated the `OrderGeneratorFactory` that now creates the Invoice and the Transactions linked to paid installments from the order's payment schedule. This commit fix it by taking away the creation of the invoice and the transaction within the debug view class and let the factory create them.

Reproductible seed was causing an issue while using the debug payment view. Duplicated address issues. Since the OrderGeneratorFactory now handles the invoices, and the recipient main address, we can let it generate random data for debug purposes.

lunika

I don't fully understand what is made in this PR, We have to discuss it to be sure everything is covered.

lunika · 2024-10-15T08:48:58Z

src/backend/joanie/core/models/products.py

@@ -1140,6 +1139,21 @@ def set_installment_refused(self, installment_id):
        ActivityLog.create_payment_failed_activity_log(self)
        self._set_installment_state(installment_id, enums.PAYMENT_STATE_REFUSED)

+    def set_installment_refunded(self, installment_id):


The order state should not be check before trying to change an installment state ? When this method will be called ?

lunika · 2024-10-15T09:27:09Z

src/backend/joanie/payment/backends/base.py

+        if (
+            invoice.state == INVOICE_STATE_REFUNDED
+            and invoice.order.state != ORDER_STATE_REFUND
+        ):
            invoice.order.flow.cancel()


Should not be refund instead of cancel ?

lunika · 2024-10-15T09:31:55Z

src/backend/joanie/payment/backends/dummy.py

+            notification_request.body.decode("utf-8")
+        )
+
+        return True


Why returning a boolean ?

lunika · 2024-10-15T09:32:29Z

src/backend/joanie/payment/backends/lyra/__init__.py

+                "exist at the payment provider."
+            )
+
+        return True


Same here, why returning a boolean ?

lunika · 2024-10-15T09:35:21Z

src/backend/joanie/payment/backends/base.py

-    def _do_on_refund(amount, invoice, refund_reference):
+    def _do_on_refund(
+        amount, invoice, refund_reference, installment_id, is_transaction_canceled=False
+    ):


IMO there is an issue with this method. I don't understand how you can work on refunding installment, etc while still having an order not in refund state and at the end the order is still not in refund state. Probably I'm missing something.

lunika · 2024-10-15T09:37:27Z

src/backend/joanie/payment/backends/payplug/__init__.py

@@ -244,3 +253,8 @@ def abort_payment(self, payment_id):
            payplug.Payment.abort(payment_id)
        except (Forbidden, NotFound) as error:
            raise exceptions.AbortPaymentFailed(str(error)) from error
+
+    def cancel_or_refund(self, amount, transaction_reference):


If it should be not implemented, then you should not override and keep the default behavior

lunika · 2024-10-15T09:43:12Z

src/backend/joanie/tests/payment/test_backend_base.py

+        )
+
+        self.assertEqual(transaction.invoice.type, "credit_note")
+
        # - Order has been canceled
        order.refresh_from_db()
        self.assertEqual(order.state, "canceled")


I don't understand why at the end we are in canceled state and not in refund. We have to discuss about that

lunika · 2024-10-15T09:47:19Z

src/backend/joanie/core/api/admin/__init__.py

+        if order.state != enums.ORDER_STATE_CANCELED:
+            return Response(
+                "Cannot refund an order not canceled.",
+                status=HTTPStatus.UNPROCESSABLE_ENTITY,
+            )
+
+        if not has_installment_paid(order):
+            return Response(
+                "Cannot refund an order without paid installments in payment schedule.",
+                status=HTTPStatus.BAD_REQUEST,
+            )


All this check should be called when applytin flow.refund(). IMO it is useless to do it twice. You should do a try/except on the order.flow.refund() and return the good response based on what is happening

lunika · 2024-10-15T09:50:58Z

src/backend/joanie/tests/core/test_api_admin_orders.py

+        backend.handle_notification(request)
+
+        order.refresh_from_db()
+        self.assertEqual(


Also all installments should have a refunded state ?

jonathanreveille added the feature label Sep 24, 2024

jonathanreveille self-assigned this Sep 24, 2024

jonathanreveille changed the base branch from main to dev September 24, 2024 17:20

jonathanreveille force-pushed the dev_/cancel_and_refund_an_order branch 14 times, most recently from 4b58c2a to c490589 Compare October 1, 2024 17:06

jonathanreveille force-pushed the dev_/cancel_and_refund_an_order branch 2 times, most recently from 0bd8a1e to 34b8fe8 Compare October 3, 2024 16:48

jbpenrath force-pushed the dev branch 2 times, most recently from 07e01cf to 2594fc0 Compare October 7, 2024 12:56

jonathanreveille force-pushed the dev_/cancel_and_refund_an_order branch 9 times, most recently from e626aea to 3e1c709 Compare October 10, 2024 16:44

jonathanreveille force-pushed the dev_/cancel_and_refund_an_order branch 3 times, most recently from e1b2424 to 5f7da1a Compare October 10, 2024 17:09

jonathanreveille changed the base branch from dev to main October 10, 2024 17:11

jonathanreveille force-pushed the dev_/cancel_and_refund_an_order branch 2 times, most recently from f0dbbc0 to b8f8313 Compare October 10, 2024 17:18

jonathanreveille added 5 commits October 10, 2024 19:18

🐛(backend) debug payment view fix

2f06a54

Reproductible seed was causing an issue while using the debug payment view. Duplicated address issues. Since the OrderGeneratorFactory now handles the invoices, and the recipient main address, we can let it generate random data for debug purposes.

jonathanreveille force-pushed the dev_/cancel_and_refund_an_order branch from b8f8313 to 2f06a54 Compare October 10, 2024 17:19

jonathanreveille requested review from kernicPanel, lunika and jbpenrath October 10, 2024 17:21

lunika reviewed Oct 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel and refund an order with payment provider #930

Cancel and refund an order with payment provider #930

jonathanreveille commented Sep 24, 2024 •

edited

Loading

lunika left a comment

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

lunika Oct 15, 2024

Cancel and refund an order with payment provider #930

Are you sure you want to change the base?

Cancel and refund an order with payment provider #930

Conversation

jonathanreveille commented Sep 24, 2024 • edited Loading

Purpose

Proposal

lunika left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanreveille commented Sep 24, 2024 •

edited

Loading