Add support for Third Party Payout service (#42)

* Add support for third party payouts

* Fix PEP-8 fixes

* Remove bank details from payout validation

If card details are provided, bank details are no longer mandatory.

* Remove trailing comma (style fix)

* Handle validation error with status code 500

* Billing address is not mandatory for storeDetailAndSubmitThirdParty

* Add test cases for all payout actions

* Fix wrong indentation

* Use assertRaisesRegexp to be backward compat with Python 2.7

* check required fields recursively

Author: woochica

Adyen/__init__.py

@@ -17,6 +17,7 @@
     AdyenBase,
     AdyenRecurring,
     AdyenPayment,
+    AdyenThirdPartyPayout,
     AdyenHPP)
 
 from .httpclient import HTTPClient
@@ -33,6 +34,7 @@ class Adyen(AdyenBase):
     def __init__(self, **kwargs):
         self.client = AdyenClient(**kwargs)
         self.payment = AdyenPayment(client=self.client)
+        self.payout = AdyenThirdPartyPayout(client=self.client)
         self.hpp = AdyenHPP(client=self.client)
         self.recurring = AdyenRecurring(client=self.client)
 
@@ -41,3 +43,4 @@ def __init__(self, **kwargs):
 recurring = _base_adyen_obj.recurring
 hpp = _base_adyen_obj.hpp
 payment = _base_adyen_obj.payment
+payout = _base_adyen_obj.payout

Adyen/client.py

@@ -136,7 +136,7 @@ def _review_payout_username(self, **kwargs):
             review_payout_username = kwargs['username']
         elif self.review_payout_username:
             review_payout_username = self.review_payout_username
-        if not review_payout_username:
+        else:
             errorstring = """AdyenInvalidRequestError: Please set your review payout
             webservice username. You can do this by running
             'Adyen.review_payout_username = 'Your payout username' """
@@ -149,7 +149,7 @@ def _review_payout_pass(self, **kwargs):
             review_payout_password = kwargs["password"]
         elif self.review_payout_password:
             review_payout_password = self.review_payout_password
-        if not review_payout_password:
+        else:
             errorstring = """AdyenInvalidRequestError: Please set your review payout
             webservice password. You can do this by running
             'Adyen.review_payout_password = 'Your payout password'"""
@@ -162,7 +162,7 @@ def _store_payout_username(self, **kwargs):
             store_payout_username = kwargs['username']
         elif self.store_payout_username:
             store_payout_username = self.store_payout_username
-        if not store_payout_username:
+        else:
             errorstring = """AdyenInvalidRequestError: Please set your store payout
             webservice username. You can do this by running
             'Adyen.store_payout_username = 'Your payout username'"""
@@ -175,7 +175,7 @@ def _store_payout_pass(self, **kwargs):
             store_payout_password = kwargs["password"]
         elif self.store_payout_password:
             store_payout_password = self.store_payout_password
-        if not store_payout_password:
+        else:
             errorstring = """AdyenInvalidRequestError: Please set your store payout
             webservice password. You can do this by running
             'Adyen.store_payout_password = 'Your payout password'"""
@@ -552,6 +552,15 @@ def _handle_http_error(self, url, response_obj, status_code, psp_ref,
                 )
 
         elif status_code == 500:
+            if response_obj.get("errorType") == "validation":
+                err_args = (response_obj.get("errorCode"),
+                            response_obj.get("message"),
+                            status_code)
+                erstr = "Received validation error with errorCode: %s," \
+                        " message: %s, HTTP Code: %s. Please verify" \
+                        " the values provided." % err_args
+                raise AdyenAPIValidationError(erstr)
+
             if response_obj.get("message") == "Failed to serialize node " \
                                               "Failed to parse [123.34]" \
                                               " as a Long":

Adyen/services.py

@@ -222,5 +222,58 @@ def cancel_or_refund(self, request="", **kwargs):
         action = "cancelOrRefund"
 
         if validation.check_in(request, action):
-            return self.client.call_api(request, self.service,
-                                        action, **kwargs)
+            return self.client.call_api(
+                request, self.service, action, **kwargs
+            )
+
+
+class AdyenThirdPartyPayout(AdyenServiceBase):
+    """This represents the Adyen API Third Party Payouts Service.
+
+    https://docs.adyen.com/developers/api-reference/third-party-payouts-api
+
+    The AdyenThirdPartyPayout class is accessible as adyen.payout.method(args)
+
+    Args:
+        client (AdyenAPIClient, optional): An API client for the service to
+            use. If not provided, a new API client will be created.
+    """
+
+    def __init__(self, client=None):
+        super(AdyenThirdPartyPayout, self).__init__(client=client)
+        self.service = "Payout"
+
+    def confirm(self, request=None, **kwargs):
+        action = "confirmThirdParty"
+        if validation.check_in(request, action):
+            return self.client.call_api(
+                request, self.service, action, **kwargs
+            )
+
+    def decline(self, request=None, **kwargs):
+        action = "declineThirdParty"
+        if validation.check_in(request, action):
+            return self.client.call_api(
+                request, self.service, action, **kwargs
+            )
+
+    def store_detail(self, request=None, **kwargs):
+        action = "storeDetail"
+        if validation.check_in(request, action):
+            return self.client.call_api(
+                request, self.service, action, **kwargs
+            )
+
+    def submit(self, request=None, **kwargs):
+        action = "submitThirdParty"
+        if validation.check_in(request, action):
+            return self.client.call_api(
+                request, self.service, action, **kwargs
+            )
+
+    def store_detail_and_submit(self, request=None, **kwargs):
+        action = "storeDetailAndSubmitThirdParty"
+        if validation.check_in(request, action):
+            return self.client.call_api(
+                request, self.service, action, **kwargs
+            )

Adyen/validation.py

@@ -1,4 +1,5 @@
 from __future__ import absolute_import, division, unicode_literals
+import re
 
 actions = {}
 actions['listRecurringDetails'] = ["shopperReference"]
@@ -16,17 +17,53 @@
 actions['refund'] = ["modificationAmount", "originalReference"]
 actions['cancelOrRefund'] = ["originalReference"]
 
+payout_required_fields = {
+    'confirmThirdParty': (
+        'merchantAccount',
+        'originalReference'
+    ),
+    'declineThirdParty': (
+        'merchantAccount',
+        'originalReference'
+    ),
+    'storeDetail': (
+        'merchantAccount',
+        'recurring.contract',
+    ),
+    'submitThirdParty': (
+        'amount.currency',
+        'amount.value',
+        'merchantAccount',
+        'recurring.contract',
+        'reference',
+        'shopperEmail',
+        'shopperReference',
+        'selectedRecurringDetailReference'
+    ),
+    'storeDetailAndSubmitThirdParty': (
+        'amount.currency',
+        'amount.value',
+        'merchantAccount',
+        'recurring.contract',
+        'reference',
+        'shopperEmail',
+        'shopperReference',
+    )
+}
+
+actions.update(payout_required_fields)
+
 
 def check_in(request, action):
     # This function checks for missing properties in the request dict
     # for the corresponding action.
 
     if request:
-        action = actions[action]
+        required_fields = actions[action]
         missing = []
-        for x in action:
-            if x not in request:
-                missing.append(x)
+        for field in required_fields:
+            if not is_key_present(request, field):
+                missing.append(field)
         if len(missing) > 0:
             missing_string = ""
             for idx, val in enumerate(missing):
@@ -43,3 +80,15 @@ def check_in(request, action):
         erstr = "Provide a request dict with the following properties:" \
                 " %s" % req_str
         raise ValueError(erstr)
+
+
+def is_key_present(request, key):
+    m = re.search('([^\.]+)\.(.+)', key)
+    if m:
+        parent_key = m.group(1)
+        child_key = m.group(2)
+        if parent_key in request:
+            return is_key_present(request[parent_key], child_key)
+    elif key in request:
+        return True
+    return False