onlinepayments-sdk-python3 7.4.1__py3-none-any.whl

onlinepayments/sdk/domain/redirect_payment_product5001_specific_input.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5001SpecificInput(DataObject):
+
+    __exemption_request: Optional[str] = None
+    __subsequent_type: Optional[str] = None
+
+    @property
+    def exemption_request(self) -> Optional[str]:
+        """
+        | In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up. This field indicates the reason for the authentication exemption request. Allowed values:
+        
+        * low-value - The transaction amount is below the 30€, with a maximum of 5 transactions or €100 accumulated per customer.
+        * transaction-risk-analysis - The transaction has been assessed as low risk by the merchant's fraud prevention system.
+
+        Type: str
+        """
+        return self.__exemption_request
+
+    @exemption_request.setter
+    def exemption_request(self, value: Optional[str]) -> None:
+        self.__exemption_request = value
+
+    @property
+    def subsequent_type(self) -> Optional[str]:
+        """
+        | Determines the type of the subsequent that will be used. Allowed values:
+        
+        * recurring - Transactions processed at fixed, regular intervals not to exceed one year between Transactions, representing an agreement between a consumer and a merchant to purchase goods or services provided over a period of time. Note that a recurring MIT transaction is initiated by the merchant (payee) not the customer (payer) and so is out of scope of PSD2. Recurring transactions that are in scope of PSD2 (and therefore may benefit from the recurring transaction exemption) are those that are customer (payer) initiates, e.g. standing orders set up from a bank account.
+        * installment - Installment payments describe a single purchase of goods or services billed to a consumer in multiple transactions over a period of time agreed by the consumer and merchant.
+        * other - other cases
+
+        Type: str
+        """
+        return self.__subsequent_type
+
+    @subsequent_type.setter
+    def subsequent_type(self, value: Optional[str]) -> None:
+        self.__subsequent_type = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5001SpecificInput, self).to_dictionary()
+        if self.exemption_request is not None:
+            dictionary['exemptionRequest'] = self.exemption_request
+        if self.subsequent_type is not None:
+            dictionary['subsequentType'] = self.subsequent_type
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5001SpecificInput':
+        super(RedirectPaymentProduct5001SpecificInput, self).from_dictionary(dictionary)
+        if 'exemptionRequest' in dictionary:
+            self.exemption_request = dictionary['exemptionRequest']
+        if 'subsequentType' in dictionary:
+            self.subsequent_type = dictionary['subsequentType']
+        return self

onlinepayments/sdk/domain/redirect_payment_product5300_specific_input.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5300SpecificInput(DataObject):
+
+    __birth_city: Optional[str] = None
+    __birth_country: Optional[str] = None
+    __birth_zip_code: Optional[str] = None
+    __channel: Optional[str] = None
+    __loyalty_card_number: Optional[str] = None
+    __second_installment_payment_date: Optional[str] = None
+    __session_duration: Optional[int] = None
+    __title: Optional[str] = None
+
+    @property
+    def birth_city(self) -> Optional[str]:
+        """
+        | The city of the address where the customer was born
+
+        Type: str
+        """
+        return self.__birth_city
+
+    @birth_city.setter
+    def birth_city(self, value: Optional[str]) -> None:
+        self.__birth_city = value
+
+    @property
+    def birth_country(self) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code of the address where the customer was born
+
+        Type: str
+        """
+        return self.__birth_country
+
+    @birth_country.setter
+    def birth_country(self, value: Optional[str]) -> None:
+        self.__birth_country = value
+
+    @property
+    def birth_zip_code(self) -> Optional[str]:
+        """
+        | The zip code of the address where the customer was born
+
+        Type: str
+        """
+        return self.__birth_zip_code
+
+    @birth_zip_code.setter
+    def birth_zip_code(self, value: Optional[str]) -> None:
+        self.__birth_zip_code = value
+
+    @property
+    def channel(self) -> Optional[str]:
+        """
+        | The channel used by the customer
+
+        Type: str
+        """
+        return self.__channel
+
+    @channel.setter
+    def channel(self, value: Optional[str]) -> None:
+        self.__channel = value
+
+    @property
+    def loyalty_card_number(self) -> Optional[str]:
+        """
+        | The number of customer's loyalty card or program
+
+        Type: str
+        """
+        return self.__loyalty_card_number
+
+    @loyalty_card_number.setter
+    def loyalty_card_number(self, value: Optional[str]) -> None:
+        self.__loyalty_card_number = value
+
+    @property
+    def second_installment_payment_date(self) -> Optional[str]:
+        """
+        | The date of the second installment (YYYYMMDD)
+
+        Type: str
+        """
+        return self.__second_installment_payment_date
+
+    @second_installment_payment_date.setter
+    def second_installment_payment_date(self, value: Optional[str]) -> None:
+        self.__second_installment_payment_date = value
+
+    @property
+    def session_duration(self) -> Optional[int]:
+        """
+        | The duration of the session in seconds
+
+        Type: int
+        """
+        return self.__session_duration
+
+    @session_duration.setter
+    def session_duration(self, value: Optional[int]) -> None:
+        self.__session_duration = value
+
+    @property
+    def title(self) -> Optional[str]:
+        """
+        | Descriptive text that is used towards the customer, either during an online checkout at a third party or on the customer's statement.
+
+        Type: str
+        """
+        return self.__title
+
+    @title.setter
+    def title(self, value: Optional[str]) -> None:
+        self.__title = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5300SpecificInput, self).to_dictionary()
+        if self.birth_city is not None:
+            dictionary['birthCity'] = self.birth_city
+        if self.birth_country is not None:
+            dictionary['birthCountry'] = self.birth_country
+        if self.birth_zip_code is not None:
+            dictionary['birthZipCode'] = self.birth_zip_code
+        if self.channel is not None:
+            dictionary['channel'] = self.channel
+        if self.loyalty_card_number is not None:
+            dictionary['loyaltyCardNumber'] = self.loyalty_card_number
+        if self.second_installment_payment_date is not None:
+            dictionary['secondInstallmentPaymentDate'] = self.second_installment_payment_date
+        if self.session_duration is not None:
+            dictionary['sessionDuration'] = self.session_duration
+        if self.title is not None:
+            dictionary['title'] = self.title
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5300SpecificInput':
+        super(RedirectPaymentProduct5300SpecificInput, self).from_dictionary(dictionary)
+        if 'birthCity' in dictionary:
+            self.birth_city = dictionary['birthCity']
+        if 'birthCountry' in dictionary:
+            self.birth_country = dictionary['birthCountry']
+        if 'birthZipCode' in dictionary:
+            self.birth_zip_code = dictionary['birthZipCode']
+        if 'channel' in dictionary:
+            self.channel = dictionary['channel']
+        if 'loyaltyCardNumber' in dictionary:
+            self.loyalty_card_number = dictionary['loyaltyCardNumber']
+        if 'secondInstallmentPaymentDate' in dictionary:
+            self.second_installment_payment_date = dictionary['secondInstallmentPaymentDate']
+        if 'sessionDuration' in dictionary:
+            self.session_duration = dictionary['sessionDuration']
+        if 'title' in dictionary:
+            self.title = dictionary['title']
+        return self

onlinepayments/sdk/domain/redirect_payment_product5402_specific_input.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5402SpecificInput(DataObject):
+
+    __complete_remaining_payment_amount: Optional[bool] = None
+
+    @property
+    def complete_remaining_payment_amount(self) -> Optional[bool]:
+        """
+        | Determines how the remaining payment amount is handled if the initial payment is insufficient.
+        
+        * ``true``: The payment process will continue on our side, allowing the customer to pay the outstanding amount using a different payment method.
+        * ``false``: Merchant must create and process a separate payment for the remaining amount independently.
+
+        Type: bool
+        """
+        return self.__complete_remaining_payment_amount
+
+    @complete_remaining_payment_amount.setter
+    def complete_remaining_payment_amount(self, value: Optional[bool]) -> None:
+        self.__complete_remaining_payment_amount = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5402SpecificInput, self).to_dictionary()
+        if self.complete_remaining_payment_amount is not None:
+            dictionary['completeRemainingPaymentAmount'] = self.complete_remaining_payment_amount
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5402SpecificInput':
+        super(RedirectPaymentProduct5402SpecificInput, self).from_dictionary(dictionary)
+        if 'completeRemainingPaymentAmount' in dictionary:
+            self.complete_remaining_payment_amount = dictionary['completeRemainingPaymentAmount']
+        return self

onlinepayments/sdk/domain/redirect_payment_product5403_specific_input.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5403SpecificInput(DataObject):
+
+    __complete_remaining_payment_amount: Optional[bool] = None
+
+    @property
+    def complete_remaining_payment_amount(self) -> Optional[bool]:
+        """
+        | Determines how the remaining payment amount is handled if the initial payment is insufficient.
+        
+        * ``true``: The payment process will continue on our side, allowing the customer to pay the outstanding amount using a different payment method.
+        * ``false``: Merchant must create and process a separate payment for the remaining amount independently.
+
+        Type: bool
+        """
+        return self.__complete_remaining_payment_amount
+
+    @complete_remaining_payment_amount.setter
+    def complete_remaining_payment_amount(self, value: Optional[bool]) -> None:
+        self.__complete_remaining_payment_amount = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5403SpecificInput, self).to_dictionary()
+        if self.complete_remaining_payment_amount is not None:
+            dictionary['completeRemainingPaymentAmount'] = self.complete_remaining_payment_amount
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5403SpecificInput':
+        super(RedirectPaymentProduct5403SpecificInput, self).from_dictionary(dictionary)
+        if 'completeRemainingPaymentAmount' in dictionary:
+            self.complete_remaining_payment_amount = dictionary['completeRemainingPaymentAmount']
+        return self

onlinepayments/sdk/domain/redirect_payment_product5406_specific_input.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .customer_bank_account import CustomerBankAccount
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5406SpecificInput(DataObject):
+
+    __customer_bank_account: Optional[CustomerBankAccount] = None
+
+    @property
+    def customer_bank_account(self) -> Optional[CustomerBankAccount]:
+        """
+        | Data of customer bank account
+
+        Type: :class:`onlinepayments.sdk.domain.customer_bank_account.CustomerBankAccount`
+        """
+        return self.__customer_bank_account
+
+    @customer_bank_account.setter
+    def customer_bank_account(self, value: Optional[CustomerBankAccount]) -> None:
+        self.__customer_bank_account = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5406SpecificInput, self).to_dictionary()
+        if self.customer_bank_account is not None:
+            dictionary['customerBankAccount'] = self.customer_bank_account.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5406SpecificInput':
+        super(RedirectPaymentProduct5406SpecificInput, self).from_dictionary(dictionary)
+        if 'customerBankAccount' in dictionary:
+            if not isinstance(dictionary['customerBankAccount'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['customerBankAccount']))
+            value = CustomerBankAccount()
+            self.customer_bank_account = value.from_dictionary(dictionary['customerBankAccount'])
+        return self

onlinepayments/sdk/domain/redirect_payment_product5408_specific_input.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .customer_bank_account import CustomerBankAccount
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5408SpecificInput(DataObject):
+
+    __customer_bank_account: Optional[CustomerBankAccount] = None
+    __instant_payment_only: Optional[bool] = None
+
+    @property
+    def customer_bank_account(self) -> Optional[CustomerBankAccount]:
+        """
+        | Data of customer bank account
+
+        Type: :class:`onlinepayments.sdk.domain.customer_bank_account.CustomerBankAccount`
+        """
+        return self.__customer_bank_account
+
+    @customer_bank_account.setter
+    def customer_bank_account(self, value: Optional[CustomerBankAccount]) -> None:
+        self.__customer_bank_account = value
+
+    @property
+    def instant_payment_only(self) -> Optional[bool]:
+        """
+        * true - consumer can only use instant payment for Account to Account Bank transfer payments
+        * false - consumer can only use standard payment for Account to Account Bank transfer payments
+
+        Type: bool
+        """
+        return self.__instant_payment_only
+
+    @instant_payment_only.setter
+    def instant_payment_only(self, value: Optional[bool]) -> None:
+        self.__instant_payment_only = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5408SpecificInput, self).to_dictionary()
+        if self.customer_bank_account is not None:
+            dictionary['customerBankAccount'] = self.customer_bank_account.to_dictionary()
+        if self.instant_payment_only is not None:
+            dictionary['instantPaymentOnly'] = self.instant_payment_only
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5408SpecificInput':
+        super(RedirectPaymentProduct5408SpecificInput, self).from_dictionary(dictionary)
+        if 'customerBankAccount' in dictionary:
+            if not isinstance(dictionary['customerBankAccount'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['customerBankAccount']))
+            value = CustomerBankAccount()
+            self.customer_bank_account = value.from_dictionary(dictionary['customerBankAccount'])
+        if 'instantPaymentOnly' in dictionary:
+            self.instant_payment_only = dictionary['instantPaymentOnly']
+        return self

onlinepayments/sdk/domain/redirect_payment_product5410_specific_input.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from datetime import date
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5410SpecificInput(DataObject):
+
+    __second_installment_payment_date: Optional[date] = None
+
+    @property
+    def second_installment_payment_date(self) -> Optional[date]:
+        """
+        | The date of the second installment (YYYYMMDD)
+
+        Type: date
+        """
+        return self.__second_installment_payment_date
+
+    @second_installment_payment_date.setter
+    def second_installment_payment_date(self, value: Optional[date]) -> None:
+        self.__second_installment_payment_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5410SpecificInput, self).to_dictionary()
+        if self.second_installment_payment_date is not None:
+            dictionary['secondInstallmentPaymentDate'] = DataObject.format_date(self.second_installment_payment_date)
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5410SpecificInput':
+        super(RedirectPaymentProduct5410SpecificInput, self).from_dictionary(dictionary)
+        if 'secondInstallmentPaymentDate' in dictionary:
+            self.second_installment_payment_date = DataObject.parse_date(dictionary['secondInstallmentPaymentDate'])
+        return self

onlinepayments/sdk/domain/redirect_payment_product5412_specific_input.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5412SpecificInput(DataObject):
+
+    __adjustable_amount: Optional[bool] = None
+    __beneficiary_id: Optional[str] = None
+
+    @property
+    def adjustable_amount(self) -> Optional[bool]:
+        """
+        | If true, the customer can adjust the portion of the total amount paid using this payment method in the ANCV app at authentication time.
+
+        Type: bool
+        """
+        return self.__adjustable_amount
+
+    @adjustable_amount.setter
+    def adjustable_amount(self, value: Optional[bool]) -> None:
+        self.__adjustable_amount = value
+
+    @property
+    def beneficiary_id(self) -> Optional[str]:
+        """
+        | The 11 digits CV Connect ID of the customer. If this ID is not provided, the customer's e-mail address will be used, if available. The customer will be able to confirm their ID before proceeding with payment.
+
+        Type: str
+        """
+        return self.__beneficiary_id
+
+    @beneficiary_id.setter
+    def beneficiary_id(self, value: Optional[str]) -> None:
+        self.__beneficiary_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5412SpecificInput, self).to_dictionary()
+        if self.adjustable_amount is not None:
+            dictionary['adjustableAmount'] = self.adjustable_amount
+        if self.beneficiary_id is not None:
+            dictionary['beneficiaryId'] = self.beneficiary_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5412SpecificInput':
+        super(RedirectPaymentProduct5412SpecificInput, self).from_dictionary(dictionary)
+        if 'adjustableAmount' in dictionary:
+            self.adjustable_amount = dictionary['adjustableAmount']
+        if 'beneficiaryId' in dictionary:
+            self.beneficiary_id = dictionary['beneficiaryId']
+        return self

onlinepayments/sdk/domain/redirect_payment_product5601_specific_input.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct5601SpecificInput(DataObject):
+
+    __complete_remaining_payment_amount: Optional[bool] = None
+
+    @property
+    def complete_remaining_payment_amount(self) -> Optional[bool]:
+        """
+        | Determines how the remaining payment amount is handled if the initial payment is insufficient.
+        
+        * ``true``: The payment process will continue on our side, allowing the customer to pay the outstanding amount using a different payment method.
+        * ``false``: Merchant must create and process a separate payment for the remaining amount independently.
+
+        Type: bool
+        """
+        return self.__complete_remaining_payment_amount
+
+    @complete_remaining_payment_amount.setter
+    def complete_remaining_payment_amount(self, value: Optional[bool]) -> None:
+        self.__complete_remaining_payment_amount = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct5601SpecificInput, self).to_dictionary()
+        if self.complete_remaining_payment_amount is not None:
+            dictionary['completeRemainingPaymentAmount'] = self.complete_remaining_payment_amount
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct5601SpecificInput':
+        super(RedirectPaymentProduct5601SpecificInput, self).from_dictionary(dictionary)
+        if 'completeRemainingPaymentAmount' in dictionary:
+            self.complete_remaining_payment_amount = dictionary['completeRemainingPaymentAmount']
+        return self

onlinepayments/sdk/domain/redirect_payment_product809_specific_input.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RedirectPaymentProduct809SpecificInput(DataObject):
+    """
+    Deprecated; Deprecated, this is no longer used.
+    """
+
+    __issuer_id: Optional[str] = None
+
+    @property
+    def issuer_id(self) -> Optional[str]:
+        """
+        | Deprecated. Unique ID of the issuing bank of the customer
+
+        Type: str
+        """
+        return self.__issuer_id
+
+    @issuer_id.setter
+    def issuer_id(self, value: Optional[str]) -> None:
+        self.__issuer_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RedirectPaymentProduct809SpecificInput, self).to_dictionary()
+        if self.issuer_id is not None:
+            dictionary['issuerId'] = self.issuer_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RedirectPaymentProduct809SpecificInput':
+        super(RedirectPaymentProduct809SpecificInput, self).from_dictionary(dictionary)
+        if 'issuerId' in dictionary:
+            self.issuer_id = dictionary['issuerId']
+        return self