Add option to return dict from payment methods

Author: dinoperovic

docs/releases/dev.rst

@@ -1,5 +1,10 @@
 ##############
-In Development
+In development
 ##############
 
 *TBA*
+
+Changed
+-------
+
+- Payment methods can now optionally return a JSON serializable data dictionary.

docs/releases/index.rst

@@ -18,6 +18,7 @@ Release notes and upgrade information. This project adheres to
     :caption: v1.1
     :maxdepth: 1
 
+    dev
     1.1.2
     1.1.1
     1.1.0

salesman/checkout/payment.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING, List, Optional, Union
 
 from django.core.exceptions import ValidationError
 from django.http import HttpRequest
@@ -74,12 +74,14 @@ def validate_order(self, order: BaseOrder, request: HttpRequest) -> None:
             msg = _("Payment for order with status '{status}' is not allowed.")
             raise ValidationError(msg.format(status=order.status_display))
 
-    def basket_payment(self, basket: BaseBasket, request: HttpRequest) -> str:
+    def basket_payment(
+        self,
+        basket: BaseBasket,
+        request: HttpRequest,
+    ) -> Union[str, dict]:
         """
         This method gets called when new checkout is submitted and
         is responsible for creating a new order from given basket.
-        Should return the redirect url to either the next payment step or
-        the order success page. Raise ``PaymentError`` in case an issue appears.
 
         Args:
             basket (Basket): Basket instance
@@ -89,15 +91,17 @@ def basket_payment(self, basket: BaseBasket, request: HttpRequest) -> str:
             PaymentError: If error with payment occurs
 
         Returns:
-            str: Redirect url to the next step
+            Union[str, dict]: Redirect URL string or JSON serializable data dictionary
         """
         raise NotImplementedError("Method `basket_payment()` is not implemented.")
 
-    def order_payment(self, order: BaseOrder, request: HttpRequest) -> str:
+    def order_payment(
+        self,
+        order: BaseOrder,
+        request: HttpRequest,
+    ) -> Union[str, dict]:
         """
         This method gets called when payment for an existing order is requested.
-        Should return the redirect url to either the next payment step or the
-        order success page. Raise ``PaymentError`` in case an issue appears.
 
         Args:
             order (Order): Order instance
@@ -107,7 +111,7 @@ def order_payment(self, order: BaseOrder, request: HttpRequest) -> str:
             PaymentError: If error with payment occurs
 
         Returns:
-            str: Redirect url to the next step
+            Union[str, dict]: Redirect URL string or JSON serializable data dictionary
         """
         raise NotImplementedError("Method `order_payment()` is not implemented.")
 

salesman/checkout/serializers.py

@@ -38,7 +38,6 @@ class CheckoutSerializer(serializers.Serializer):
     Serializer for processing a basket payment.
     """
 
-    url = serializers.CharField(read_only=True)
     email = serializers.EmailField(write_only=True)
     shipping_address = serializers.CharField(
         allow_blank=True,
@@ -98,5 +97,9 @@ def save(self):
         basket.save(update_fields=['extra'])
         # Process the payment.
         payment = self.validated_data['payment_method']
-        url = payment.basket_payment(basket, request)
-        self.validated_data['url'] = url  # type: ignore
+        data = payment.basket_payment(basket, request)
+        # Returning string in payments converts to a URL data value.
+        if isinstance(data, str):
+            data = {'url': data}
+        # Override the serializer data with the payment data.
+        self._data = data

salesman/orders/serializers.py

@@ -178,7 +178,6 @@ class OrderPaySerializer(serializers.Serializer):
     Serializer used to pay for existing order via payment method.
     """
 
-    url = serializers.CharField(read_only=True)
     payment_method = serializers.ChoiceField(
         choices=payment_methods_pool.get_choices('order'),
         write_only=True,
@@ -197,8 +196,12 @@ def save(self):
         # Process the payment.
         order, request = self.context['order'], self.context['request']
         payment = self.validated_data['payment_method']
-        url = payment.order_payment(order, request)
-        self.validated_data['url'] = url  # type: ignore
+        data = payment.order_payment(order, request)
+        # Returning string in payments converts to a URL data value.
+        if isinstance(data, str):
+            data = {'url': data}
+        # Override the serializer data with the payment data.
+        self._data = data
 
 
 class OrderRefundSerializer(serializers.Serializer):