25571 - Send queue message for reversal

jobs/payment-jobs/pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.12"
-pay-api = {git = "https://github.com/ochiu/sbc-pay.git", branch = "25334-EFT-Statement-Payment", subdirectory = "pay-api"}
+pay-api = {git = "https://github.com/seeker25/sbc-pay.git", branch = "25571", subdirectory = "pay-api"}
 flask = "^3.0.2"
 flask-sqlalchemy = "^3.1.1"
 sqlalchemy = "^2.0.28"

jobs/payment-jobs/tasks/bcol_refund_confirmation_task.py

@@ -20,7 +20,8 @@
 
 from flask import current_app
 from pay_api.models import Invoice, InvoiceReference, Payment, db
-from pay_api.utils.enums import InvoiceStatus, PaymentSystem
+from pay_api.services.bcol_service import BcolService
+from pay_api.utils.enums import InvoiceStatus, PaymentSystem, TransactionStatus
 from sentry_sdk import capture_message
 from sqlalchemy import text
 
@@ -121,4 +122,5 @@ def _compare_and_update_records(cls, invoice_refs: List[InvoiceReference], bcol_
             invoice.invoice_status_code = InvoiceStatus.REFUNDED.value
             invoice.refund_date = datetime.now(tz=timezone.utc)
             db.session.add(invoice)
+            BcolService().release_payment_or_reversal(invoice, TransactionStatus.REVERSED.value)
         db.session.commit()

jobs/payment-jobs/tasks/direct_pay_automated_refund_task.py

@@ -30,6 +30,7 @@
     InvoiceStatus,
     PaymentMethod,
     PaymentStatus,
+    TransactionStatus,
 )
 from sentry_sdk import capture_message
 
@@ -239,6 +240,7 @@ def _set_invoice_and_payment_to_refunded(invoice: Invoice):
         payment = PaymentModel.find_payment_for_invoice(invoice.id)
         payment.payment_status_code = PaymentStatus.REFUNDED.value
         payment.save()
+        DirectPayService().release_payment_or_reversal(invoice, TransactionStatus.REVERSED.value)
 
     @classmethod
     def _set_refund_partials_posted(cls, invoice: Invoice):

jobs/payment-jobs/tasks/eft_task.py

@@ -38,6 +38,7 @@
     PaymentStatus,
     PaymentSystem,
     ReverseOperation,
+    TransactionStatus,
 )
 from sentry_sdk import capture_message
 from sqlalchemy import func
@@ -449,3 +450,4 @@ def _handle_invoice_refund(cls, invoice: InvoiceModel, invoice_reference: Invoic
         invoice.refund_date = datetime.now(tz=timezone.utc)
         invoice.refund = invoice.total
         invoice.flush()
+        EftService().release_payment_or_reversal(invoice, TransactionStatus.REVERSED.value)

pay-api/src/pay_api/resources/v1/account.py

@@ -88,6 +88,7 @@ def get_eft_accounts():
     return jsonify(response), status
 
 
+# NOTE: STRR and BAR use this route to check the PAD status and/or payment method, be careful when changing.
 @bp.route("/<string:account_number>", methods=["GET", "OPTIONS"])
 @cross_origin(origins="*", methods=["GET", "PUT", "DELETE"])
 @_jwt.requires_auth

pay-api/src/pay_api/services/base_payment_system.py

@@ -35,6 +35,7 @@
 from pay_api.models.refunds_partial import RefundPartialLine
 from pay_api.services import gcp_queue_publisher
 from pay_api.services.cfs_service import CFSService
+from pay_api.services.flags import flags
 from pay_api.services.invoice import Invoice
 from pay_api.services.invoice_reference import InvoiceReference
 from pay_api.services.payment import Payment
@@ -195,7 +196,7 @@ def ensure_no_payment_blockers(self, payment_account: PaymentAccount) -> None:
             raise BusinessException(Error.EFT_INVOICES_OVERDUE)
 
     @staticmethod
-    def _release_payment(invoice: Invoice):
+    def release_payment_or_reversal(invoice: Invoice, transaction_status=TransactionStatus.COMPLETED.value):
         """Release record."""
         from .payment_transaction import PaymentTransaction  # pylint:disable=import-outside-toplevel,cyclic-import
 
@@ -207,9 +208,14 @@ def _release_payment(invoice: Invoice):
         ]:
             return
 
-        payload = PaymentTransaction.create_event_payload(invoice, TransactionStatus.COMPLETED.value)
+        if transaction_status == TransactionStatus.REVERSED.value and not flags.is_on(
+            "queue-message-for-reversals", default=False
+        ):
+            return
+
+        payload = PaymentTransaction.create_event_payload(invoice, transaction_status)
         try:
-            current_app.logger.info(f"Releasing record for invoice {invoice.id}")
+            current_app.logger.info(f"Releasing record for invoice {invoice.id} with status {transaction_status}")
             gcp_queue_publisher.publish_to_queue(
                 gcp_queue_publisher.QueueMessage(
                     source=QueueSources.PAY_API.value,
@@ -370,7 +376,7 @@ def wrapper(*func_args, **func_kwargs):
             current_app.logger.info("Completing the payment as sandbox token is detected.")
             instance: PaymentSystemService = func_args[0]
             instance.complete_payment(func_args[1], func_args[2])  # invoice and invoice ref
-            instance._release_payment(func_args[1])  # pylint: disable=protected-access
+            instance.release_payment_or_reversal(func_args[1])
             return None
         return function(*func_args, **func_kwargs)
 

pay-api/src/pay_api/services/bcol_service.py

@@ -199,4 +199,4 @@ def complete_post_invoice(
         """Complete any post payment activities if needed."""
         self.complete_payment(invoice, invoice_reference)
         # Publish message to the queue with payment token, so that they can release records on their side.
-        self._release_payment(invoice=invoice)
+        self.release_payment_or_reversal(invoice=invoice)

pay-api/src/pay_api/services/eft_service.py

@@ -103,7 +103,7 @@ def create_invoice(
     def complete_post_invoice(self, invoice: Invoice, invoice_reference: InvoiceReference) -> None:
         """Complete any post invoice activities if needed."""
         # Publish message to the queue with payment token, so that they can release records on their side.
-        self._release_payment(invoice=invoice)
+        self.release_payment_or_reversal(invoice=invoice)
 
     def get_default_invoice_status(self) -> str:
         """Return the default status for invoice when created."""

pay-api/src/pay_api/services/ejv_pay_service.py

@@ -74,7 +74,7 @@ def complete_post_invoice(self, invoice: Invoice, invoice_reference: InvoiceRefe
             self.complete_payment(invoice, invoice_reference)
 
         # Publish message to the queue with payment token, so that they can release records on their side.
-        self._release_payment(invoice=invoice)
+        self.release_payment_or_reversal(invoice=invoice)
 
     def process_cfs_refund(
         self,

pay-api/src/pay_api/services/internal_pay_service.py

@@ -99,7 +99,7 @@ def complete_post_invoice(self, invoice: Invoice, invoice_reference: InvoiceRefe
         if invoice.invoice_status_code != InvoiceStatus.APPROVED.value:
             self.complete_payment(invoice, invoice_reference)
             # Publish message to the queue with payment token, so that they can release records on their side.
-        self._release_payment(invoice=invoice)
+        self.release_payment_or_reversal(invoice=invoice)
 
     def get_default_invoice_status(self) -> str:
         """Return the default status for invoice when created."""

pay-api/src/pay_api/services/online_banking_service.py

@@ -68,7 +68,7 @@ def get_receipt(
 
     def apply_credit(self, invoice: Invoice) -> None:
         """Apply credit to the invoice."""
-        self._release_payment(invoice=invoice)
+        self.release_payment_or_reversal(invoice=invoice)
 
     def cancel_invoice(self, payment_account: PaymentAccount, inv_number: str):
         """Adjust the invoice to zero."""

pay-api/src/pay_api/services/pad_service.py

@@ -137,7 +137,7 @@ def complete_post_invoice(
     ) -> None:
         """Complete any post invoice activities if needed."""
         # Publish message to the queue with payment token, so that they can release records on their side.
-        self._release_payment(invoice=invoice)
+        self.release_payment_or_reversal(invoice=invoice)
 
     def process_cfs_refund(
         self,

pay-api/src/pay_api/services/payment_service.py

@@ -184,7 +184,7 @@ def _handle_invoice(cls, invoice, invoice_reference, pay_service, skip_payment):
                 invoice_amount=invoice.total,
                 payment_account_id=invoice.payment_account_id,
             ).commit()
-            pay_service._release_payment(invoice)  # pylint: disable=protected-access
+            pay_service.release_payment_or_reversal(invoice)  # pylint: disable=protected-access
         else:
             # Normal flow of code here.
             invoice.commit()