mangopay4-python-sdk 3.57.0__tar.gz → 3.58.0__tar.gz

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mangopay4-python-sdk
-Version: 3.57.0
+Version: 3.58.0
 Summary: A client library written in python to work with mangopay v2 api
 Home-page: https://github.com/Mangopay/mangopay2-python-sdk
 Author: Mangopay (www.mangopay.com)

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/mangopay/fields.py

@@ -15,7 +15,8 @@ from .utils import timestamp_from_datetime, timestamp_from_date, Money, DebitedB
     BusinessRecipient, RecipientPropertySchema, IndividualRecipientPropertySchema, BusinessRecipientPropertySchema, \
     CompanyNumberValidation, ReportFilter, PayInIntentExternalData, PayInIntentBuyer, SupportedBank, \
     VerificationOfPayee, PayInIntentRefund, PayInIntentCapture, PayInIntentDispute, CustomFees, MarginsResponse, \
-    UserMargin, ConsentScope, AuthenticationResult, FlowDescriptor
+    UserMargin, ConsentScope, AuthenticationResult, FlowDescriptor, SettlementFooterError, SettlementLineError, \
+    SettlementLineErrorDetail
 
 
 class FieldDescriptor(object):
@@ -1544,4 +1545,58 @@ class FlowDescriptorField(Field):
                 result['Beneficiaries'] = value.beneficiaries
             return result
 
+        return value
+
+
+class SettlementFooterErrorsField(Field):
+    def python_value(self, value):
+        if isinstance(value, list):
+            return [SettlementFooterError(footer_name=item.get('FooterName', None),
+                                          code=item.get('Code', None),
+                                          description=item.get('Description', None))
+                    if isinstance(item, dict) else item
+                    for item in value]
+
+        return value
+
+    def api_value(self, value):
+        value = super(SettlementFooterErrorsField, self).api_value(value)
+
+        if isinstance(value, list):
+            return [item.to_api_json() if isinstance(item, SettlementFooterError) else item
+                    for item in value]
+
+        return value
+
+
+class SettlementLinesErrorsField(Field):
+    def python_value(self, value):
+        if isinstance(value, list):
+            return [self._to_line_error(item) if isinstance(item, dict) else item
+                    for item in value]
+
+        return value
+
+    @staticmethod
+    def _to_line_error(item):
+        details = item.get('Details', None)
+        if isinstance(details, list):
+            details = [SettlementLineErrorDetail(code=detail.get('Code', None),
+                                                 description=detail.get('Description', None))
+                       if isinstance(detail, dict) else detail
+                       for detail in details]
+
+        return SettlementLineError(external_provider_reference=item.get('ExternalProviderReference', None),
+                                   external_transaction_type=item.get('ExternalTransactionType', None),
+                                   details=details)
+
+    def api_value(self, value):
+        value = super(SettlementLinesErrorsField, self).api_value(value)
+
+        if isinstance(value, list):
+            return [item.to_api_json() if isinstance(item, SettlementLineError) else item
+                    for item in value]
+
+        return value
+
         return value

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/mangopay/resources.py

@@ -22,7 +22,7 @@ from .fields import (PrimaryKeyField, EmailField, CharField,
                      PayInIntentExternalDataField, PayInIntentBuyerField, SupportedBanksField, VerificationOfPayeeField,
                      PayInIntentRefundField, PayInIntentCaptureField, PayInIntentDisputeField, CustomFeesField,
                      UserMarginField, MarginsResponseField, ConsentScopeField, AuthenticationResultField,
-                     FlowDescriptorField)
+                     FlowDescriptorField, SettlementFooterErrorsField, SettlementLinesErrorsField)
 from .query import InsertQuery, UpdateQuery, SelectQuery, ActionQuery, DeleteQuery
 
 
@@ -214,6 +214,13 @@ class UserConsent(BaseModel):
 
 @python_2_unicode_compatible
 class NaturalUser(User):
+    """
+    .. deprecated::
+        The non-SCA natural user endpoints are deprecated. Use :class:`NaturalUserSca`
+        (create/update via ``/sca/users/natural``) and :meth:`User.get_sca` for
+        retrieval instead. Kept for backward compatibility; will be removed in a
+        future major version.
+    """
     person_type = CharField(api_name='PersonType',
                             choices=constants.USER_TYPE_CHOICES,
                             default=constants.USER_TYPE_CHOICES.natural,
@@ -297,6 +304,13 @@ class NaturalUserSca(User):
 
 @python_2_unicode_compatible
 class LegalUser(User):
+    """
+    .. deprecated::
+        The non-SCA legal user endpoints are deprecated. Use :class:`LegalUserSca`
+        (create/update via ``/sca/users/legal``) and :meth:`User.get_sca` for
+        retrieval instead. Kept for backward compatibility; will be removed in a
+        future major version.
+    """
     person_type = CharField(api_name='PersonType',
                             choices=constants.USER_TYPE_CHOICES,
                             default=constants.USER_TYPE_CHOICES.legal,
@@ -1870,12 +1884,22 @@ class CardPreAuthorizedDepositPayIn(BaseModel):
         return insert.execute()
 
     def create_prior_to_complement(self, idempotency_key=None, **kwargs):
+        """
+        .. deprecated::
+            The capture-with-complement flow is deprecated and will be removed in a
+            future major version. Use :meth:`create_without_complement` instead.
+        """
         insert = InsertQuery(self, idempotency_key, **kwargs)
         insert.identifier = 'CREATE_PRIOR_TO_COMPLEMENT'
         insert.insert_query = self.get_field_dict()
         return insert.execute()
 
     def create_complement(self, idempotency_key=None, **kwargs):
+        """
+        .. deprecated::
+            The complement flow is deprecated and will be removed in a future major
+            version. Use :meth:`create_without_complement` instead.
+        """
         insert = InsertQuery(self, idempotency_key, **kwargs)
         insert.identifier = 'CREATE_COMPLEMENT'
         insert.insert_query = self.get_field_dict()
@@ -1921,12 +1945,22 @@ class PreAuthorizedDepositPayIn(BaseModel):
         return insert.execute()
 
     def create_prior_to_complement(self, idempotency_key=None, **kwargs):
+        """
+        .. deprecated::
+            The capture-with-complement flow is deprecated and will be removed in a
+            future major version. Use :meth:`create_without_complement` instead.
+        """
         insert = InsertQuery(self, idempotency_key, **kwargs)
         insert.identifier = 'CREATE_PRIOR_TO_COMPLEMENT'
         insert.insert_query = self.get_field_dict()
         return insert.execute()
 
     def create_complement(self, idempotency_key=None, **kwargs):
+        """
+        .. deprecated::
+            The complement flow is deprecated and will be removed in a future major
+            version. Use :meth:`create_without_complement` instead.
+        """
         insert = InsertQuery(self, idempotency_key, **kwargs)
         insert.identifier = 'CREATE_COMPLEMENT'
         insert.insert_query = self.get_field_dict()
@@ -3498,8 +3532,8 @@ class Settlement(BaseModel):
 
 
 class SettlementValidation(BaseModel):
-    footer_errors = ListField(api_name='FooterErrors')
-    lines_errors = ListField(api_name='LinesErrors')
+    footer_errors = SettlementFooterErrorsField(api_name='FooterErrors')
+    lines_errors = SettlementLinesErrorsField(api_name='LinesErrors')
 
     class Meta:
         verbose_name = 'settlement_validation'

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/mangopay/utils.py

@@ -1754,4 +1754,60 @@ class FlowDescriptor(object):
         return {
             "FlowId": self.flow_id,
             "Beneficiaries": self.beneficiaries
+        }
+
+
+@add_camelcase_aliases
+class SettlementFooterError(object):
+    def __init__(self, footer_name=None, code=None, description=None):
+        self.footer_name = footer_name
+        self.code = code
+        self.description = description
+
+    def __str__(self):
+        return 'SettlementFooterError: %s %s %s' % (self.footer_name, self.code, self.description)
+
+    def to_api_json(self):
+        return {
+            "FooterName": self.footer_name,
+            "Code": self.code,
+            "Description": self.description
+        }
+
+
+@add_camelcase_aliases
+class SettlementLineErrorDetail(object):
+    def __init__(self, code=None, description=None):
+        self.code = code
+        self.description = description
+
+    def __str__(self):
+        return 'SettlementLineErrorDetail: %s %s' % (self.code, self.description)
+
+    def to_api_json(self):
+        return {
+            "Code": self.code,
+            "Description": self.description
+        }
+
+
+@add_camelcase_aliases
+class SettlementLineError(object):
+    def __init__(self, external_provider_reference=None, external_transaction_type=None, details=None):
+        self.external_provider_reference = external_provider_reference
+        self.external_transaction_type = external_transaction_type
+        self.details = details
+
+    def __str__(self):
+        return 'SettlementLineError: %s %s' % (self.external_provider_reference, self.external_transaction_type)
+
+    def to_api_json(self):
+        details = self.details
+        if isinstance(details, list):
+            details = [d.to_api_json() if isinstance(d, SettlementLineErrorDetail) else d for d in details]
+
+        return {
+            "ExternalProviderReference": self.external_provider_reference,
+            "ExternalTransactionType": self.external_transaction_type,
+            "Details": details
         }

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/mangopay4_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mangopay4-python-sdk
-Version: 3.57.0
+Version: 3.58.0
 Summary: A client library written in python to work with mangopay v2 api
 Home-page: https://github.com/Mangopay/mangopay2-python-sdk
 Author: Mangopay (www.mangopay.com)

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/mangopay4_python_sdk.egg-info/SOURCES.txt

@@ -91,4 +91,5 @@ tests/fixtures/user_wallet.json
 tests/images/image.jpg
 tests/resources/TestKycPageFile.png
 tests/resources/settlement_sample.csv
-tests/resources/settlement_sample_bad.csv
+tests/resources/settlement_sample_bad_footer.csv
+tests/resources/settlement_sample_bad_line.csv

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/setup.py

@@ -10,7 +10,7 @@ with open(path.join(here, 'DESCRIPTION.md'), encoding='utf-8') as f:
 
 setup(
     name='mangopay4-python-sdk',
-    version='3.57.0',
+    version='3.58.0',
     description='A client library written in python to work with mangopay v2 api',
     long_description='This SDK is a client library for interacting with the Mangopay API.',
     url='https://github.com/Mangopay/mangopay2-python-sdk',

mangopay4_python_sdk-3.57.0/tests/resources/settlement_sample_bad.csv → mangopay4_python_sdk-3.58.0/tests/resources/settlement_sample_bad_footer.csv

@@ -5,4 +5,4 @@ SettlementDate,19-06-2025,,,,,,,
 ExternalProviderName,Paypal,,,,,,,
 TotalSettlementFeesAmount,0,,,,,,,
 TotalNetSettlementAmount,99999,,,,,,,
-SettlementCurrency,EUR,,,,,,
+SettlementCurrency,EURR,,,,,,

mangopay4_python_sdk-3.58.0/tests/resources/settlement_sample_bad_line.csv

@@ -0,0 +1,8 @@
+ExternalProviderReference,ExternalPaymentMethod,ExternalTransactionType,ExternalTransactionStatus,ExternalProcessingDate,Amount,Currency,ExternalInitialReference,ExternalProviderFees
+6TU984332A894613W,PAYPAL,PAYMENT,SETTLED,191-06-2025,1000,EUR,,0
+,,,,,,,,
+SettlementDate,19-06-2025,,,,,,,
+ExternalProviderName,Paypal,,,,,,,
+TotalSettlementFeesAmount,0,,,,,,,
+TotalNetSettlementAmount,99999,,,,,,,
+SettlementCurrency,EUR,,,,,,

{mangopay4_python_sdk-3.57.0 → mangopay4_python_sdk-3.58.0}/tests/test_payins.py

@@ -2519,6 +2519,7 @@ class PayInsTestLive(BaseTestLive):
         self.assertEqual('BANK_WIRE', created.payment_type)
         self.assertEqual('DIRECT', created.execution_type)
 
+    @unittest.skip("can't be tested. API returning 500")
     def test_paypal_data_collection(self):
         data = {
             "sender_account_id": "A12345N343",

mangopay4_python_sdk-3.58.0/tests/test_settlements.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+import os
+import time
+
+import requests
+import responses
+
+from mangopay.resources import Settlement, SettlementValidation
+from mangopay.utils import SettlementFooterError, SettlementLineError, SettlementLineErrorDetail
+from tests import settings
+from tests.test_base import BaseTest, BaseTestLive
+
+
+class SettlementTestLive(BaseTestLive):
+    _settlement = None
+
+    def test_generate_upload_url(self):
+        settlement = self.create_new_settlement()
+        self.assertIsNotNone(settlement.settlement_id)
+        self.assertIsNotNone(settlement.upload_url)
+
+    def test_get_settlement(self):
+        settlement = self.create_new_settlement()
+        fetched = Settlement.get(settlement.settlement_id)
+        self.assertEqual('PENDING_UPLOAD', fetched.status)
+
+    def test_generate_new_upload_url(self):
+        settlement = self.create_new_settlement()
+        new_settlement = Settlement(id=settlement.settlement_id, file_name='updated_settlement_sample.csv')
+        result = Settlement(**new_settlement.generate_new_upload_url())
+        self.assertIsNotNone(result.settlement_id)
+        self.assertIsNotNone(result.upload_url)
+
+    def test_upload_file(self):
+        settlement, response = self.upload_settlement_file('settlement_sample.csv')
+        self.assertEqual(200, response.status_code)
+
+    def test_get_validations_footer_errors(self):
+        settlement, response = self.upload_settlement_file('settlement_sample_bad_footer.csv')
+        time.sleep(20)
+        validations = SettlementValidation.get(settlement.settlement_id, page=0, per_page=10)
+        self.assertIsNotNone(validations)
+        self.assertIsNotNone(validations.footer_errors)
+
+        footer_error = validations.footer_errors[0]
+        self.assertIsNotNone(footer_error.footer_name)
+        self.assertIsNotNone(footer_error.code)
+        self.assertIsNotNone(footer_error.description)
+
+    def test_get_validations_line_errors(self):
+        settlement, response = self.upload_settlement_file('settlement_sample_bad_line.csv')
+        time.sleep(20)
+        validations = SettlementValidation.get(settlement.settlement_id, page=0, per_page=10)
+        self.assertIsNotNone(validations)
+        self.assertIsNotNone(validations.lines_errors)
+
+        line_error = validations.lines_errors[0]
+        self.assertIsNotNone(line_error.external_provider_reference)
+        self.assertIsNotNone(line_error.external_transaction_type)
+        self.assertIsNotNone(line_error.details)
+
+        line_error_detail = line_error.details[0]
+        self.assertIsNotNone(line_error_detail.code)
+        self.assertIsNotNone(line_error_detail.description)
+
+    def test_cancel_settlement(self):
+        settlement, response = self.upload_settlement_file('settlement_sample_bad_line.csv')
+        cancelled = Settlement.cancel(settlement.settlement_id)
+        self.assertIsNotNone(cancelled)
+        self.assertEqual("CANCELLED", cancelled['status'])
+
+    @staticmethod
+    def create_new_settlement():
+        if SettlementTestLive._settlement is None:
+            settlement = Settlement(file_name='settlement_sample.csv')
+            SettlementTestLive._settlement = Settlement(**settlement.generate_upload_url())
+        return SettlementTestLive._settlement
+
+    def upload_settlement_file(self, file_name):
+        settlement = Settlement(file_name=file_name)
+        settlement = Settlement(**settlement.generate_upload_url())
+        file_path = os.path.join(os.path.dirname(__file__), 'resources', file_name)
+        with open(file_path, 'rb') as f:
+            data = f.read()
+
+        headers = {'Content-Type': 'text/csv'}
+        response = requests.put(settlement.upload_url, data=data, headers=headers)
+        return settlement, response
+
+
+class SettlementValidationTest(BaseTest):
+    @responses.activate
+    def test_get_validations_dto(self):
+        settlement_id = "settlement_12345"
+        v3_url = settings.MANGOPAY_API_SANDBOX_URL.replace('v2.01', 'V3.0')
+        self.register_mock({
+            'method': responses.GET,
+            'url': v3_url + settings.MANGOPAY_CLIENT_ID +
+                   '/payins/intents/settlements/' + settlement_id + '/validations',
+            'body': {
+                "FooterErrors": [
+                    {
+                        "FooterName": "DeclaredIntentAmount",
+                        "Code": "TOTAL_NET_MISCALCULATED",
+                        "Description": "Declared intent amount does not match actual settlement amount"
+                    }
+                ],
+                "LinesErrors": [
+                    {
+                        "ExternalProviderReference": "d3f7a1b2-4c5e-6789-abcd-ef0123456789",
+                        "ExternalTransactionType": "REFUND",
+                        "Details": [
+                            {
+                                "Code": "MATCH_REF_NOT_FOUND",
+                                "Description": "ExternalProviderReference not found for any existing Intent in the system"
+                            },
+                            {
+                                "Code": "FORMAT_DATE_INVALID",
+                                "Description": "ExternalProcessingDate format is invalid. Expected DD-MM-YYYY"
+                            }
+                        ]
+                    }
+                ]
+            },
+            'status': 200
+        })
+
+        validations = SettlementValidation.get(settlement_id, page=1, per_page=10)
+
+        self.assertIsNotNone(validations)
+        self.assertIsNotNone(validations.footer_errors)
+        self.assertIsNotNone(validations.lines_errors)
+
+        self.assertEqual(1, len(validations.footer_errors))
+        footer_error = validations.footer_errors[0]
+        self.assertIsInstance(footer_error, SettlementFooterError)
+        self.assertEqual("DeclaredIntentAmount", footer_error.footer_name)
+        self.assertEqual("TOTAL_NET_MISCALCULATED", footer_error.code)
+        self.assertEqual("Declared intent amount does not match actual settlement amount",
+                         footer_error.description)
+
+        self.assertEqual(1, len(validations.lines_errors))
+        line_error = validations.lines_errors[0]
+        self.assertIsInstance(line_error, SettlementLineError)
+        self.assertEqual("d3f7a1b2-4c5e-6789-abcd-ef0123456789", line_error.external_provider_reference)
+        self.assertEqual("REFUND", line_error.external_transaction_type)
+        self.assertIsNotNone(line_error.details)
+        self.assertEqual(2, len(line_error.details))
+
+        first_detail = line_error.details[0]
+        self.assertIsInstance(first_detail, SettlementLineErrorDetail)
+        self.assertEqual("MATCH_REF_NOT_FOUND", first_detail.code)
+        self.assertEqual("ExternalProviderReference not found for any existing Intent in the system",
+                         first_detail.description)
+
+        second_detail = line_error.details[1]
+        self.assertEqual("FORMAT_DATE_INVALID", second_detail.code)
+        self.assertEqual("ExternalProcessingDate format is invalid. Expected DD-MM-YYYY",
+                         second_detail.description)

mangopay4_python_sdk-3.57.0/tests/test_settlements.py

@@ -1,60 +0,0 @@
-# -*- coding: utf-8 -*-
-import os
-import requests
-
-from mangopay.resources import Settlement, SettlementValidation
-from tests.test_base import BaseTestLive
-
-
-class SettlementTestLive(BaseTestLive):
-    _settlement = None
-
-    def test_generate_upload_url(self):
-        settlement = self.create_new_settlement()
-        self.assertIsNotNone(settlement.settlement_id)
-        self.assertIsNotNone(settlement.upload_url)
-
-    def test_get_settlement(self):
-        settlement = self.create_new_settlement()
-        fetched = Settlement.get(settlement.settlement_id)
-        self.assertEqual('PENDING_UPLOAD', fetched.status)
-
-    def test_generate_new_upload_url(self):
-        settlement = self.create_new_settlement()
-        new_settlement = Settlement(id=settlement.settlement_id, file_name='updated_settlement_sample.csv')
-        result = Settlement(**new_settlement.generate_new_upload_url())
-        self.assertIsNotNone(result.settlement_id)
-        self.assertIsNotNone(result.upload_url)
-
-    def test_upload_file(self):
-        settlement, response = self.upload_settlement_file('settlement_sample.csv')
-        self.assertEqual(200, response.status_code)
-
-    def test_get_validaitons(self):
-        settlement, response = self.upload_settlement_file('settlement_sample_bad.csv')
-        validations = SettlementValidation.get(settlement.settlement_id, page=1, per_page=10)
-        self.assertIsNotNone(validations)
-
-    def test_cancel_settlement(self):
-        settlement, response = self.upload_settlement_file('settlement_sample_bad.csv')
-        cancelled = Settlement.cancel(settlement.settlement_id)
-        self.assertIsNotNone(cancelled)
-        self.assertEqual("CANCELLED", cancelled['status'])
-
-    @staticmethod
-    def create_new_settlement():
-        if SettlementTestLive._settlement is None:
-            settlement = Settlement(file_name='settlement_sample.csv')
-            SettlementTestLive._settlement = Settlement(**settlement.generate_upload_url())
-        return SettlementTestLive._settlement
-
-    def upload_settlement_file(self, file_name):
-        settlement = Settlement(file_name=file_name)
-        settlement = Settlement(**settlement.generate_upload_url())
-        file_path = os.path.join(os.path.dirname(__file__), 'resources', file_name)
-        with open(file_path, 'rb') as f:
-            data = f.read()
-
-        headers = {'Content-Type': 'text/csv'}
-        response = requests.put(settlement.upload_url, data=data, headers=headers)
-        return settlement, response