onlinepayments-sdk-python3 6.4.0__tar.gz → 7.1.0__tar.gz

{onlinepayments_sdk_python3-6.4.0/onlinepayments_sdk_python3.egg-info → onlinepayments_sdk_python3-7.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onlinepayments-sdk-python3
-Version: 6.4.0
+Version: 7.1.0
 Summary: SDK to communicate with the Online Payments platform using the Online Payments Server API
 Home-page: https://github.com/wl-online-payments-direct/sdk-python3
 Author: Worldline Direct support team

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/communication/metadata_provider.py

@@ -23,7 +23,7 @@ class MetadataProvider(IMetadataProvider):
     """
     Provides meta info about the server.
     """
-    __sdk_version = "6.4.0"
+    __sdk_version = "7.1.0"
     __server_meta_info_header = "X-GCS-ServerMetaInfo"
     __prohibited_headers = tuple(sorted([__server_meta_info_header, "X-GCS-Idempotence-Key", "Date", "Content-Type", "Authorization"],
                                         key=str.lower))

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/bank_account_iban.py

@@ -14,7 +14,7 @@ class BankAccountIban(DataObject):
     @property
     def iban(self) -> Optional[str]:
         """
-        | The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits. Required for the creation of a Payout Required for Create and Update token. Required for Create mandate and Create payment with mandate calls.
+        | The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits. Required for the creation of a Payout Required for Create and Update token. Required for Create mandate and Create payment with mandate calls. It is optional when the mandate signature type is "AIS"; otherwise, it is mandatory.
 
         Type: str
         """

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/cancel_payment_request.py

@@ -2,10 +2,11 @@
 #
 # This file was automatically generated.
 #
-from typing import Optional
+from typing import List, Optional
 
 from .amount_of_money import AmountOfMoney
 from .data_object import DataObject
+from .line_item_detail import LineItemDetail
 from .operation_payment_references import OperationPaymentReferences
 
 
@@ -13,6 +14,7 @@ class CancelPaymentRequest(DataObject):
 
     __amount_of_money: Optional[AmountOfMoney] = None
     __is_final: Optional[bool] = None
+    __line_item_details: Optional[List[LineItemDetail]] = None
     __operation_references: Optional[OperationPaymentReferences] = None
 
     @property
@@ -41,6 +43,19 @@ class CancelPaymentRequest(DataObject):
     def is_final(self, value: Optional[bool]) -> None:
         self.__is_final = value
 
+    @property
+    def line_item_details(self) -> Optional[List[LineItemDetail]]:
+        """
+        | List of lineItemIds and quantities for capture/refund/cancellation.
+
+        Type: list[:class:`onlinepayments.sdk.domain.line_item_detail.LineItemDetail`]
+        """
+        return self.__line_item_details
+
+    @line_item_details.setter
+    def line_item_details(self, value: Optional[List[LineItemDetail]]) -> None:
+        self.__line_item_details = value
+
     @property
     def operation_references(self) -> Optional[OperationPaymentReferences]:
         """
@@ -60,6 +75,11 @@ class CancelPaymentRequest(DataObject):
             dictionary['amountOfMoney'] = self.amount_of_money.to_dictionary()
         if self.is_final is not None:
             dictionary['isFinal'] = self.is_final
+        if self.line_item_details is not None:
+            dictionary['lineItemDetails'] = []
+            for element in self.line_item_details:
+                if element is not None:
+                    dictionary['lineItemDetails'].append(element.to_dictionary())
         if self.operation_references is not None:
             dictionary['operationReferences'] = self.operation_references.to_dictionary()
         return dictionary
@@ -73,6 +93,13 @@ class CancelPaymentRequest(DataObject):
             self.amount_of_money = value.from_dictionary(dictionary['amountOfMoney'])
         if 'isFinal' in dictionary:
             self.is_final = dictionary['isFinal']
+        if 'lineItemDetails' in dictionary:
+            if not isinstance(dictionary['lineItemDetails'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['lineItemDetails']))
+            self.line_item_details = []
+            for element in dictionary['lineItemDetails']:
+                value = LineItemDetail()
+                self.line_item_details.append(value.from_dictionary(element))
         if 'operationReferences' in dictionary:
             if not isinstance(dictionary['operationReferences'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['operationReferences']))

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/capture_payment_request.py

@@ -2,9 +2,10 @@
 #
 # This file was automatically generated.
 #
-from typing import Optional
+from typing import List, Optional
 
 from .data_object import DataObject
+from .line_item_detail import LineItemDetail
 from .operation_payment_references import OperationPaymentReferences
 from .payment_references import PaymentReferences
 
@@ -13,6 +14,7 @@ class CapturePaymentRequest(DataObject):
 
     __amount: Optional[int] = None
     __is_final: Optional[bool] = None
+    __line_item_details: Optional[List[LineItemDetail]] = None
     __operation_references: Optional[OperationPaymentReferences] = None
     __references: Optional[PaymentReferences] = None
 
@@ -42,6 +44,19 @@ class CapturePaymentRequest(DataObject):
     def is_final(self, value: Optional[bool]) -> None:
         self.__is_final = value
 
+    @property
+    def line_item_details(self) -> Optional[List[LineItemDetail]]:
+        """
+        | List of lineItemIds and quantities for capture/refund/cancellation.
+
+        Type: list[:class:`onlinepayments.sdk.domain.line_item_detail.LineItemDetail`]
+        """
+        return self.__line_item_details
+
+    @line_item_details.setter
+    def line_item_details(self, value: Optional[List[LineItemDetail]]) -> None:
+        self.__line_item_details = value
+
     @property
     def operation_references(self) -> Optional[OperationPaymentReferences]:
         """
@@ -74,6 +89,11 @@ class CapturePaymentRequest(DataObject):
             dictionary['amount'] = self.amount
         if self.is_final is not None:
             dictionary['isFinal'] = self.is_final
+        if self.line_item_details is not None:
+            dictionary['lineItemDetails'] = []
+            for element in self.line_item_details:
+                if element is not None:
+                    dictionary['lineItemDetails'].append(element.to_dictionary())
         if self.operation_references is not None:
             dictionary['operationReferences'] = self.operation_references.to_dictionary()
         if self.references is not None:
@@ -86,6 +106,13 @@ class CapturePaymentRequest(DataObject):
             self.amount = dictionary['amount']
         if 'isFinal' in dictionary:
             self.is_final = dictionary['isFinal']
+        if 'lineItemDetails' in dictionary:
+            if not isinstance(dictionary['lineItemDetails'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['lineItemDetails']))
+            self.line_item_details = []
+            for element in dictionary['lineItemDetails']:
+                value = LineItemDetail()
+                self.line_item_details.append(value.from_dictionary(element))
         if 'operationReferences' in dictionary:
             if not isinstance(dictionary['operationReferences'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['operationReferences']))

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/card_bin_details.py

@@ -174,7 +174,7 @@ class CardBinDetails(DataObject):
     @property
     def country_code(self) -> Optional[str]:
         """
-        | ISO 3166-1 alpha-2 country code
+        | ISO 3166-1 alpha-2 country code of the card issuer
 
         Type: str
         """

onlinepayments_sdk_python3-7.1.0/onlinepayments/sdk/domain/card_data_without_cvv.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class CardDataWithoutCvv(DataObject):
+
+    __card_number: Optional[str] = None
+    __cardholder_name: Optional[str] = None
+    __expiry_date: Optional[str] = None
+
+    @property
+    def card_number(self) -> Optional[str]:
+        """
+        | The complete credit/debit card number (also known as the PAN) is always obfuscated in any of our responses.
+
+        Type: str
+        """
+        return self.__card_number
+
+    @card_number.setter
+    def card_number(self, value: Optional[str]) -> None:
+        self.__card_number = value
+
+    @property
+    def cardholder_name(self) -> Optional[str]:
+        """
+        | The card holder's name on the card.
+
+        Type: str
+        """
+        return self.__cardholder_name
+
+    @cardholder_name.setter
+    def cardholder_name(self, value: Optional[str]) -> None:
+        self.__cardholder_name = value
+
+    @property
+    def expiry_date(self) -> Optional[str]:
+        """
+        | Expiry date of the card Format: MMYY
+
+        Type: str
+        """
+        return self.__expiry_date
+
+    @expiry_date.setter
+    def expiry_date(self, value: Optional[str]) -> None:
+        self.__expiry_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CardDataWithoutCvv, self).to_dictionary()
+        if self.card_number is not None:
+            dictionary['cardNumber'] = self.card_number
+        if self.cardholder_name is not None:
+            dictionary['cardholderName'] = self.cardholder_name
+        if self.expiry_date is not None:
+            dictionary['expiryDate'] = self.expiry_date
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CardDataWithoutCvv':
+        super(CardDataWithoutCvv, self).from_dictionary(dictionary)
+        if 'cardNumber' in dictionary:
+            self.card_number = dictionary['cardNumber']
+        if 'cardholderName' in dictionary:
+            self.cardholder_name = dictionary['cardholderName']
+        if 'expiryDate' in dictionary:
+            self.expiry_date = dictionary['expiryDate']
+        return self

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/card_essentials.py

@@ -203,7 +203,7 @@ class CardEssentials(DataObject):
     @property
     def country_code(self) -> Optional[str]:
         """
-        | ISO 3166-1 alpha-2 country code
+        | ISO 3166-1 alpha-2 country code of the card issuer
 
         Type: str
         """

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/card_payment_method_specific_input.py

@@ -8,6 +8,7 @@ from .card import Card
 from .card_recurrence_details import CardRecurrenceDetails
 from .currency_conversion_input import CurrencyConversionInput
 from .data_object import DataObject
+from .market_place import MarketPlace
 from .multiple_payment_information import MultiplePaymentInformation
 from .network_token_data import NetworkTokenData
 from .payment_product130_specific_input import PaymentProduct130SpecificInput
@@ -29,6 +30,7 @@ class CardPaymentMethodSpecificInput(DataObject):
     __currency_conversion: Optional[CurrencyConversionInput] = None
     __initial_scheme_transaction_id: Optional[str] = None
     __is_recurring: Optional[bool] = None
+    __market_place: Optional[MarketPlace] = None
     __multiple_payment_information: Optional[MultiplePaymentInformation] = None
     __network_token_data: Optional[NetworkTokenData] = None
     __payment_product130_specific_input: Optional[PaymentProduct130SpecificInput] = None
@@ -181,6 +183,19 @@ class CardPaymentMethodSpecificInput(DataObject):
     def is_recurring(self, value: Optional[bool]) -> None:
         self.__is_recurring = value
 
+    @property
+    def market_place(self) -> Optional[MarketPlace]:
+        """
+        | Object containing marketplace-related data for additional information on sub-merchants (retailers) transacting via the marketplace’s platform. This object is required for platforms onboarding multiple sellers to ensure accurate identification and attribution of each transaction. The platform must collect and submit the retailer’s country and regional information in accordance with card scheme requirements. In some cases, Visa may treat specific regions—such as EU member states—as a single country entity for regulatory and reporting purposes.
+
+        Type: :class:`onlinepayments.sdk.domain.market_place.MarketPlace`
+        """
+        return self.__market_place
+
+    @market_place.setter
+    def market_place(self, value: Optional[MarketPlace]) -> None:
+        self.__market_place = value
+
     @property
     def multiple_payment_information(self) -> Optional[MultiplePaymentInformation]:
         """
@@ -197,7 +212,7 @@ class CardPaymentMethodSpecificInput(DataObject):
     @property
     def network_token_data(self) -> Optional[NetworkTokenData]:
         """
-        | Object containing network token details
+        | Object containing Network Token details
 
         Type: :class:`onlinepayments.sdk.domain.network_token_data.NetworkTokenData`
         """
@@ -456,6 +471,8 @@ class CardPaymentMethodSpecificInput(DataObject):
             dictionary['initialSchemeTransactionId'] = self.initial_scheme_transaction_id
         if self.is_recurring is not None:
             dictionary['isRecurring'] = self.is_recurring
+        if self.market_place is not None:
+            dictionary['marketPlace'] = self.market_place.to_dictionary()
         if self.multiple_payment_information is not None:
             dictionary['multiplePaymentInformation'] = self.multiple_payment_information.to_dictionary()
         if self.network_token_data is not None:
@@ -520,6 +537,11 @@ class CardPaymentMethodSpecificInput(DataObject):
             self.initial_scheme_transaction_id = dictionary['initialSchemeTransactionId']
         if 'isRecurring' in dictionary:
             self.is_recurring = dictionary['isRecurring']
+        if 'marketPlace' in dictionary:
+            if not isinstance(dictionary['marketPlace'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['marketPlace']))
+            value = MarketPlace()
+            self.market_place = value.from_dictionary(dictionary['marketPlace'])
         if 'multiplePaymentInformation' in dictionary:
             if not isinstance(dictionary['multiplePaymentInformation'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['multiplePaymentInformation']))

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/card_payment_method_specific_input_base.py

@@ -7,6 +7,7 @@ from typing import Optional
 from .card_recurrence_details import CardRecurrenceDetails
 from .currency_conversion_specific_input import CurrencyConversionSpecificInput
 from .data_object import DataObject
+from .market_place import MarketPlace
 from .multiple_payment_information import MultiplePaymentInformation
 from .payment_product130_specific_input import PaymentProduct130SpecificInput
 from .payment_product3012_specific_input import PaymentProduct3012SpecificInput
@@ -23,6 +24,7 @@ class CardPaymentMethodSpecificInputBase(DataObject):
     __authorization_mode: Optional[str] = None
     __currency_conversion_specific_input: Optional[CurrencyConversionSpecificInput] = None
     __initial_scheme_transaction_id: Optional[str] = None
+    __market_place: Optional[MarketPlace] = None
     __multiple_payment_information: Optional[MultiplePaymentInformation] = None
     __payment_product130_specific_input: Optional[PaymentProduct130SpecificInput] = None
     __payment_product3012_specific_input: Optional[PaymentProduct3012SpecificInput] = None
@@ -98,6 +100,19 @@ class CardPaymentMethodSpecificInputBase(DataObject):
     def initial_scheme_transaction_id(self, value: Optional[str]) -> None:
         self.__initial_scheme_transaction_id = value
 
+    @property
+    def market_place(self) -> Optional[MarketPlace]:
+        """
+        | Object containing marketplace-related data for additional information on sub-merchants (retailers) transacting via the marketplace’s platform. This object is required for platforms onboarding multiple sellers to ensure accurate identification and attribution of each transaction. The platform must collect and submit the retailer’s country and regional information in accordance with card scheme requirements. In some cases, Visa may treat specific regions—such as EU member states—as a single country entity for regulatory and reporting purposes.
+
+        Type: :class:`onlinepayments.sdk.domain.market_place.MarketPlace`
+        """
+        return self.__market_place
+
+    @market_place.setter
+    def market_place(self, value: Optional[MarketPlace]) -> None:
+        self.__market_place = value
+
     @property
     def multiple_payment_information(self) -> Optional[MultiplePaymentInformation]:
         """
@@ -244,10 +259,7 @@ class CardPaymentMethodSpecificInputBase(DataObject):
     @property
     def tokenize(self) -> Optional[bool]:
         """
-        | Indicates if this transaction should be tokenized
-        
-        * true - Tokenize the transaction. Note that a payment on the payment platform that results in a status REDIRECTED cannot be tokenized in this way.
-        * false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
+        | Indicates if this transaction should be tokenized * true - Tokenize the transaction. * false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments. Note: This property is deprecated for Hosted Checkout integrations. It has been deprecated by hostedCheckoutSpecificInput.cardPaymentMethodSpecificInput.tokenizationMode.
 
         Type: bool
         """
@@ -317,6 +329,8 @@ class CardPaymentMethodSpecificInputBase(DataObject):
             dictionary['currencyConversionSpecificInput'] = self.currency_conversion_specific_input.to_dictionary()
         if self.initial_scheme_transaction_id is not None:
             dictionary['initialSchemeTransactionId'] = self.initial_scheme_transaction_id
+        if self.market_place is not None:
+            dictionary['marketPlace'] = self.market_place.to_dictionary()
         if self.multiple_payment_information is not None:
             dictionary['multiplePaymentInformation'] = self.multiple_payment_information.to_dictionary()
         if self.payment_product130_specific_input is not None:
@@ -362,6 +376,11 @@ class CardPaymentMethodSpecificInputBase(DataObject):
             self.currency_conversion_specific_input = value.from_dictionary(dictionary['currencyConversionSpecificInput'])
         if 'initialSchemeTransactionId' in dictionary:
             self.initial_scheme_transaction_id = dictionary['initialSchemeTransactionId']
+        if 'marketPlace' in dictionary:
+            if not isinstance(dictionary['marketPlace'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['marketPlace']))
+            value = MarketPlace()
+            self.market_place = value.from_dictionary(dictionary['marketPlace'])
         if 'multiplePaymentInformation' in dictionary:
             if not isinstance(dictionary['multiplePaymentInformation'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['multiplePaymentInformation']))

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/card_payment_method_specific_input_for_hosted_checkout.py

@@ -12,6 +12,7 @@ class CardPaymentMethodSpecificInputForHostedCheckout(DataObject):
     __click_to_pay: Optional[bool] = None
     __group_cards: Optional[bool] = None
     __payment_product_preferred_order: Optional[List[int]] = None
+    __tokenization_mode: Optional[str] = None
 
     @property
     def click_to_pay(self) -> Optional[bool]:
@@ -54,6 +55,24 @@ class CardPaymentMethodSpecificInputForHostedCheckout(DataObject):
     def payment_product_preferred_order(self, value: Optional[List[int]]) -> None:
         self.__payment_product_preferred_order = value
 
+    @property
+    def tokenization_mode(self) -> Optional[str]:
+        """
+        | Controls the generation and use of a token within a hosted checkout session.
+        
+        * createWithConsent - Presents the payer with a capture consent checkbox to decide whether they would like to tokenize their payment information for future use.
+        * createAlways - Tokenizes the payment information automatically without presenting the capture consent checkbox to the payer; please ensure consent is captured on your interface.
+        * useExplicitly - The payer can only use the token supplied in cardpaymentmethodspecificinput.token; if the token is invalid or no token is provided, the request will fail.
+        * noTokenization - The payer's payment information will not be tokenized and the payer will not be presented with the ability to tokenize their payment information; use this for one-off payments. Note: This property is not allowed when cardpaymentmethodspecificinput.tokenize is specified.
+
+        Type: str
+        """
+        return self.__tokenization_mode
+
+    @tokenization_mode.setter
+    def tokenization_mode(self, value: Optional[str]) -> None:
+        self.__tokenization_mode = value
+
     def to_dictionary(self) -> dict:
         dictionary = super(CardPaymentMethodSpecificInputForHostedCheckout, self).to_dictionary()
         if self.click_to_pay is not None:
@@ -65,6 +84,8 @@ class CardPaymentMethodSpecificInputForHostedCheckout(DataObject):
             for element in self.payment_product_preferred_order:
                 if element is not None:
                     dictionary['paymentProductPreferredOrder'].append(element)
+        if self.tokenization_mode is not None:
+            dictionary['tokenizationMode'] = self.tokenization_mode
         return dictionary
 
     def from_dictionary(self, dictionary: dict) -> 'CardPaymentMethodSpecificInputForHostedCheckout':
@@ -79,4 +100,6 @@ class CardPaymentMethodSpecificInputForHostedCheckout(DataObject):
             self.payment_product_preferred_order = []
             for element in dictionary['paymentProductPreferredOrder']:
                 self.payment_product_preferred_order.append(element)
+        if 'tokenizationMode' in dictionary:
+            self.tokenization_mode = dictionary['tokenizationMode']
         return self

{onlinepayments_sdk_python3-6.4.0 → onlinepayments_sdk_python3-7.1.0}/onlinepayments/sdk/domain/card_payout_method_specific_input.py

@@ -44,7 +44,7 @@ class CardPayoutMethodSpecificInput(DataObject):
     @property
     def payout_reason(self) -> Optional[str]:
         """
-        | Allows you to additionally specify the reason for initiating the payout for authorization purposes. If this field is not specified, authorisation of the payment will be made according to your merchant profile. Possible values are:
+        | Allows you to additionally specify the reason for initiating the payout for authorization purposes. If this field is not specified, authorization of the payment will be made according to your merchant profile. Possible values are:
         
         * Gambling
         * Refund