Added: Card pre-authorization (with PayIn), PayInBankWire, get user cards & transactions, new type of documents for KYC

Author: arek-felinczak

mangopay2-python-sdk.pyproj

@@ -28,7 +28,9 @@
     <Compile Include="mangopaysdk\entities\bankaccount.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\entities\aaaabankwire.py" />
     <Compile Include="mangopaysdk\entities\card.py" />
+    <Compile Include="mangopaysdk\entities\cardpreauthorization.py" />
     <Compile Include="mangopaysdk\entities\cardregistration.py" />
     <Compile Include="mangopaysdk\entities\kycpage.py" />
     <Compile Include="mangopaysdk\entities\kycdocument.py" />
@@ -39,6 +41,7 @@
     <Compile Include="mangopaysdk\entities\entitybase.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\tools\apicardpreauthorizations.py" />
     <Compile Include="mangopaysdk\tools\apicards.py" />
     <Compile Include="mangopaysdk\tools\apicardregistrations.py" />
     <Compile Include="mangopaysdk\tools\apievents.py" />
@@ -113,9 +116,11 @@
     <Compile Include="mangopaysdk\types\payinpaymentdetailscard.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\types\payinpaymentdetailspreauthorized.py" />
     <Compile Include="mangopaysdk\types\payoutpaymentdetails.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\types\payinpaymentdetailsbankwire.py" />
     <Compile Include="mangopaysdk\types\payoutpaymentdetailsbankwire.py">
       <SubType>Code</SubType>
     </Compile>
@@ -169,6 +174,7 @@
       <SubType>Code</SubType>
     </Compile>
     <Compile Include="setup.py" />
+    <Compile Include="tests\testcardpreauthorizations.py" />
     <Compile Include="tests\testevents.py" />
     <Compile Include="tests\testrefunds.py">
       <SubType>Code</SubType>

mangopaysdk/entities/cardpreauthorization.py

@@ -0,0 +1,57 @@
+from mangopaysdk.entities.entitybase import EntityBase
+
+
+class CardPreAuthorization(EntityBase):
+    """CardPreAuthorization entity"""
+    
+    def __init__(self, id = None):
+        self.Tag = None
+        # The user Id of the author of the pre-authorization
+        self.AuthorId = None
+        # Money object - amount debited on the bank account of the Author in cents
+        self.DebitedFunds = None
+        # Mode3DSType { DEFAULT, FORCE }
+        self.SecureMode = None
+        # This is the URL where users are automatically redirected after 3D secure validation (if activated)
+        self.SecureModeReturnURL = None
+        # The ID of the registered card (Got through CardRegistration object) 
+        self.CardId = None
+         # The Id of the associated PayIn
+        self.PayInId = None
+
+        # Boolean. The value is 'true' if the SecureMode was used
+        self.SecureModeNeeded = None
+        # This is the URL where users are automatically redirected after 3D secure validation (if activated)
+        self.SecureModeReturnURL = None 
+        # returned from API
+        self.SecureModeRedirectURL = None
+        # CardPreAuthorizationStatus - The status of the payment after the PreAuthorization: WAITING, CANCELED, EXPIRED, VALIDATED
+        
+        self.PaymentStatus = None
+        # TransactionStatus: CREATED, SUCCEEDED, FAILED
+        self.Status = None
+        self.ResultCode = None
+        self.ResultMessage = None
+        # How the PreAuthorization has been executed. 
+        self.ExecutionType = None
+        # The date when the payment is processed
+        self.ExpirationDate = None       
+
+        return super(CardPreAuthorization, self).__init__(id)
+
+    def GetReadOnlyProperties(self):
+        properties = super(CardPreAuthorization, self).GetReadOnlyProperties()
+        properties.append('ResultMessage')
+        properties.append('ResultCode')
+        properties.append('Status')
+        return properties
+    
+    def GetSubObjects(self):
+        return { 
+            'DebitedFunds': 'Money'
+        }
+
+
+
+    
+    

mangopaysdk/entities/payin.py

@@ -14,16 +14,19 @@ def __init__(self, id = None):
         # One of PayInExecutionDetails implementations, depending on ExecutionType
         self.ExecutionDetails = None
         return super(PayIn, self).__init__(id)    
-
+    
     def GetDependsObjects(self):
         return { 
-                'PaymentType': {'_property_name': 'PaymentDetails', 'CARD': 'PayInPaymentDetailsCard'},
-                'ExecutionType': {
+                'PaymentType': {
+                    '_property_name': 'PaymentDetails', 
+                    'CARD': 'PayInPaymentDetailsCard',
+                    'BANK_WIRE': 'PayInPaymentDetailsBankWire'
+                }, 'ExecutionType': {
                     '_property_name': 'ExecutionDetails', 
                     'WEB': 'PayInExecutionDetailsWeb',
                     'DIRECT': 'PayInExecutionDetailsDirect'                
-                    }
-               }
+                }
+        }
 
     def GetReadOnlyProperties(self):
         properties = super(PayIn, self).GetReadOnlyProperties()

mangopaysdk/mangopayapi.py

@@ -1,4 +1,4 @@
-from mangopaysdk.tools import apioauth, apiclients, apiusers, apiwallets, apitransfers, apipayins, apipayouts, apievents
+from mangopaysdk.tools import apioauth, apiclients, apiusers, apiwallets, apitransfers, apipayins, apipayouts, apievents, apicardpreauthorizations
 from mangopaysdk.tools import apirefunds, apicardregistrations, apicards
 from mangopaysdk.configuration import Configuration
 from mangopaysdk.tools.storages.authorizationtokenmanager import AuthorizationTokenManager
@@ -34,5 +34,6 @@ def __init__(self):
         self.payOuts = apipayouts.ApiPayOuts(self)
         self.refunds = apirefunds.ApiRefunds(self)
         self.cardRegistrations = apicardregistrations.ApiCardRegistrations(self)
+        self.cardPreAuthorizations = apicardpreauthorizations.ApiCardPreAuthorizations(self)        
         self.cards = apicards.ApiCards(self)
         self.events = apievents.ApiEvents(self)

mangopaysdk/tools/apibase.py

@@ -19,9 +19,12 @@
 from mangopaysdk.entities.card import Card
 from mangopaysdk.entities.refund import Refund
 from mangopaysdk.entities.cardregistration import CardRegistration
+from mangopaysdk.entities.cardpreauthorization import CardPreAuthorization
 from mangopaysdk.types.payinexecutiondetails import PayInExecutionDetails
 from mangopaysdk.types.payinexecutiondetailsweb import PayInExecutionDetailsWeb
 from mangopaysdk.types.payinpaymentdetails import PayInPaymentDetails
+from mangopaysdk.types.payinpaymentdetailspreauthorized import PayInPaymentDetailsPreAuthorized
+from mangopaysdk.types.payinpaymentdetailsbankwire import PayInPaymentDetailsBankWire
 from mangopaysdk.types.payinpaymentdetailscard import PayInPaymentDetailsCard
 from mangopaysdk.types.payoutpaymentdetails import PayOutPaymentDetails
 from mangopaysdk.types.payinexecutiondetailsdirect import PayInExecutionDetailsDirect
@@ -79,6 +82,8 @@ class ApiBase(object):
         'payins_bankwire-preauthorized_create' : ('/payins/bankwire/preauthorized/', 'POST'),
         'payins_bankwire-recurrentexecution_create' : ('/payins/bankwire/recurrent-pay-in-execution/', 'POST'),
 
+        'payins_preauthorized-direct_create' : ('/payins/PreAuthorized/direct/', 'POST'),
+
         'payins_directcredit-web_create' : ('/payins/direct-credit/web/', 'POST'),
         'payins_directcredit-direct_create' : ('/payins/direct-credit/direct/', 'POST'),
         'payins_directcredit-preauthorized_create' : ('/payins/direct-credit/preauthorized/', 'POST'),
@@ -93,6 +98,9 @@ class ApiBase(object):
         'payouts_get' : ('/payouts/%s', 'GET'),
         'payouts_createrefunds' : ('/payouts/%s/refunds', 'POST'),
         'payouts_getrefunds' : ('/payouts/%s/refunds', 'GET'),
+        'preauthorizations_create' : ('/preauthorizations/card/direct', 'POST'),
+        'preauthorizations_save' : ('/preauthorizations/%s', 'PUT'),
+        'preauthorizations_get' : ('/preauthorizations/%s', 'GET'),
 
         'reccurringpayinorders_create' : ('/reccurring-pay-in-orders', 'POST'),
         'reccurringpayinorders_get' : ('/reccurring-pay-in-orders/%s', 'GET'),
@@ -132,6 +140,8 @@ class ApiBase(object):
         'users_getproofofregistration' : ('/users/%s/ProofOfRegistration', 'GET'),
         'users_getshareholderdeclaration' : ('/users/%s/ShareholderDeclaration', 'GET'),
         'users_getbankaccount' : ('/users/%s/bankaccounts/%s', 'GET'),
+        'users_getcards' : ('/users/%s/cards', 'GET'),
+        'users_transactions' : ('/users/%s/transactions', 'GET'),
         'users_getpaymentcard' : ('/users/%s/payment-cards/%s', 'GET'),
         'users_savenaturals' : ('/users/natural/%s', 'PUT'),
         'users_savelegals' : ('/users/legal/%s', 'PUT'),
@@ -274,7 +284,17 @@ def _castResponseToEntity(self, response, entityClassName, asDependentObject = F
                 objList.append(self._castResponseToEntity(reponseObject, entityClassName))
             return objList
 
-        if len(entityClassName) > 0:
+        if len(entityClassName) > 0 and entityClassName == "Transaction" and response['Type'] != None:
+            if response['Type'] == "PAYIN":
+                entityClassName = "PayIn"
+            if response['Type'] == "PAYOUT":
+                entityClassName = "PayOut"
+            if response['Type'] == "REFUND":
+                entityClassName = "Refund"
+            if response['Type'] == "TRANSFER":
+                entityClassName = "Transfer"
+            entity = globals()[entityClassName]()
+        elif len(entityClassName) > 0 :
             entity = globals()[entityClassName]()
         else:
             raise Exception ('Cannot cast response to entity object. Wrong entity class name')
@@ -286,7 +306,7 @@ def _castResponseToEntity(self, response, entityClassName, asDependentObject = F
 
             if hasattr(entity, name):
                 # is sub object?
-                if subObjects.get(name) != None:
+                if subObjects.get(name) != None and value != None:
                     object = self._castResponseToEntity(value, subObjects[name])
                     setattr(entity, name, object)
                 else:

mangopaysdk/tools/apicardpreauthorizations.py

@@ -0,0 +1,29 @@
+from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.entities.cardpreauthorization import CardPreAuthorization
+
+
+class ApiCardPreAuthorizations (ApiBase):
+    """Class to managemen MangoPay API for card pre-authorization.
+       see: http://docs.mangopay.com/api-references/card/pre-authorization/
+    """
+
+    def Create(self, cardPreAuthorization):
+        """Create new card preauthorization
+        param CardPreAuthorization object to create
+        return CardPreAuthorization Object returned from API
+        """
+        return self._createObject('preauthorizations_create', cardPreAuthorization, 'CardPreAuthorization')
+
+    def Get(self, cardPreAuthorizationId):
+        """Get card preauthorization
+        param string CardPreAuthorization identifier
+        return CardPreAuthorization Object returned from API
+        """
+        return self._getObject('preauthorizations_get', cardPreAuthorizationId, 'CardPreAuthorization')
+
+    def Update(self, cardPreAuthorization):
+        """Update card preauthorization
+        param CardPreAuthorization object to save
+        return CardPreAuthorization Object returned from API
+        """
+        return self._saveObject('preauthorizations_save', cardPreAuthorization, 'CardPreAuthorization')

mangopaysdk/tools/apiusers.py

@@ -96,6 +96,22 @@ def GetBankAccount(self, userId, bankAccountId):
         """
         return self._getObject('users_getbankaccount', userId, 'BankAccount', bankAccountId)
 
+    def GetCards(self, userId, pagination = None):
+        """Get user payment cards.
+        param Int/GUID userId 
+        param Pagination object
+        return array or card entities
+        """
+        return self._getList('users_getcards', pagination, 'Card', userId)
+
+    def GetTransactions(self, userId, pagination = None):
+        """Get user payment cards.
+        param Int/GUID userId 
+        param Pagination object
+        return array or transactions
+        """
+        return self._getList('users_transactions', pagination, 'Transaction', userId)
+
     def GetUserResponse(self, response):
         """Get correct user object - to be used internally.
         param object response Response from API

mangopaysdk/tools/enums.py

@@ -75,6 +75,12 @@ class CardRegistrationStatus:
     ERROR = 'ERROR'
     VALIDATED = 'VALIDATED'
 
+class CardPreAuthorizationStatus:
+    WAITING = 'WAITING'
+    CANCELED = 'CANCELED'
+    EXPIRED = 'EXPIRED'
+    VALIDATED = 'VALIDATED'
+
 class EventType:
     PAYIN_NORMAL_CREATED = 'PAYIN_NORMAL_CREATED'
     PAYIN_NORMAL_SUCCEEDED = 'PAYIN_NORMAL_SUCCEEDED'
@@ -98,7 +104,10 @@ class EventType:
 class KycDocumentType:
     IDENTITY_PROOF = 'IDENTITY_PROOF'
     REGISTRATION_PROOF = 'REGISTRATION_PROOF'
-    
+    ARTICLES_OF_ASSOCIATION = 'ARTICLES_OF_ASSOCIATION'
+    SHAREHOLDER_DECLARATION = 'SHAREHOLDER_DECLARATION'
+    ADDRESS_PROOF = 'ADDRESS_PROOF'
+
 class KycDocumentStatus: 	
     CREATED = 'CREATED'
     VALIDATION_ASKED = 'VALIDATION_ASKED'

mangopaysdk/types/dto.py

@@ -2,7 +2,7 @@ class Dto(object):
     """Abstract class for all DTOs (entities and their composites)."""
 
     def GetSubObjects(self):
-        """Get array with mapping which property is object and what type of object..
+        """Get array with mapping which property is object and what type of object.
         To be overridden in child class if has any sub objects.
         return array
         """

mangopaysdk/types/payinexecutiondetailsdirect.py

@@ -4,6 +4,7 @@
 class PayInExecutionDetailsDirect(PayInExecutionDetails):
 
     def __init__(self):
+        # direct card
         self.CardId = None
         self.SecureModeReturnURL = None
         # Mode3DSType { DEFAULT, FORCE }

mangopaysdk/types/payinpaymentdetailsbankwire.py

@@ -0,0 +1,13 @@
+from mangopaysdk.types.payinpaymentdetails import PayInPaymentDetails
+
+class PayInPaymentDetailsBankWire(PayInPaymentDetails):
+    """Class represents BankWire type for mean of payment in PayIn entity."""
+
+    def __init__(self):
+        self.BankAccount = None
+        self.WireReference = None
+        self.DeclaredDebitedFunds = None
+        self.DeclaredFees = None
+
+    def GetSubObjects(self):
+        return {'BankAccount': 'BankAccount'}

mangopaysdk/types/payinpaymentdetailspreauthorized.py

@@ -0,0 +1,8 @@
+from mangopaysdk.types.payinpaymentdetails import PayInPaymentDetails
+
+
+class PayInPaymentDetailsPreAuthorized(PayInPaymentDetails):
+    
+    def __init__(self):    
+        # The ID of the Preauthorization object
+        self.PreauthorizationId = None

setup.py

@@ -3,7 +3,7 @@
 # to build - python setup.py sdist upload
 setup(
     name='mangopaysdk',
-    version='0.31',
+    version='0.32',
     author='Mangopay (www.mangopay.com)',
     author_email='it-support@mangopay.com',
     packages=['mangopaysdk', 'mangopaysdk.entities', 'mangopaysdk.tools', 'mangopaysdk.tools.storages', 'mangopaysdk.types', 'mangopaysdk.types.exceptions'],

test_suite.py

@@ -16,6 +16,7 @@
 from tests.testtokens import Test_Tokens
 from tests.testtransfers import Test_Transfers
 from tests.testevents import Test_ApiEvents
+from tests.testcardpreauthorizations import Test_CardPreAuthorization
 
 
 suite = unittest.TestSuite()
@@ -29,6 +30,7 @@
 suite.addTest(unittest.makeSuite(Test_Transfers))
 suite.addTest(unittest.makeSuite(TestRefunds))
 suite.addTest(unittest.makeSuite(Test_CardRegistrations))
+suite.addTest(unittest.makeSuite(Test_CardPreAuthorization))
 suite.addTest(unittest.makeSuite(Test_ApiEvents))
 
 modules = ['mangopaysdk']

tests/testapiusers.py

@@ -131,6 +131,22 @@ def test_Users_BankAccounts(self):
         self.assertTrue(pagination.TotalPages > 0)
         self.assertTrue(pagination.TotalItems > 0)
 
+    def test_Users_Cards(self):
+       john = self.getJohn()
+       payIn = self.getJohnsPayInCardDirect()
+       userCards = self.sdk.users.GetCards(john.Id)
+       self.assertTrue(len(userCards) == 1)
+       self.assertIsNotNone(userCards[0].CardType)
+       self.assertIsNotNone(userCards[0].Currency)
+
+    def test_Users_Transactions(self):
+       john = self.getJohn()
+       transfer = self.getJohnsTransfer()
+       userTransfers = self.sdk.users.GetTransactions(john.Id)
+       self.assertTrue(len(userTransfers) > 0)
+       self.assertIsNotNone(userTransfers[0].Type)
+       self.assertIsNotNone(userTransfers[0].Status)
+
     def test_Users_CreateKycDocument(self):
         kycDoc = self.getUserKycDocument()
         self.assertNotEqual(kycDoc.Id, None)