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

onlinepayments/sdk/domain/multiple_payment_information.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class MultiplePaymentInformation(DataObject):
+
+    __payment_pattern: Optional[str] = None
+    __total_number_of_payments: Optional[int] = None
+
+    @property
+    def payment_pattern(self) -> Optional[str]:
+        """
+        | Typology of multiple payment. Allowed values:
+        
+        * PartialShipment
+
+        Type: str
+        """
+        return self.__payment_pattern
+
+    @payment_pattern.setter
+    def payment_pattern(self, value: Optional[str]) -> None:
+        self.__payment_pattern = value
+
+    @property
+    def total_number_of_payments(self) -> Optional[int]:
+        """
+        | Total number of payments. If a payment is implied by this call, it implicitly has ordinal number 1.
+
+        Type: int
+        """
+        return self.__total_number_of_payments
+
+    @total_number_of_payments.setter
+    def total_number_of_payments(self, value: Optional[int]) -> None:
+        self.__total_number_of_payments = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MultiplePaymentInformation, self).to_dictionary()
+        if self.payment_pattern is not None:
+            dictionary['paymentPattern'] = self.payment_pattern
+        if self.total_number_of_payments is not None:
+            dictionary['totalNumberOfPayments'] = self.total_number_of_payments
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MultiplePaymentInformation':
+        super(MultiplePaymentInformation, self).from_dictionary(dictionary)
+        if 'paymentPattern' in dictionary:
+            self.payment_pattern = dictionary['paymentPattern']
+        if 'totalNumberOfPayments' in dictionary:
+            self.total_number_of_payments = dictionary['totalNumberOfPayments']
+        return self

onlinepayments/sdk/domain/network_token_data.py

@@ -0,0 +1,127 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class NetworkTokenData(DataObject):
+
+    __cardholder_name: Optional[str] = None
+    __cryptogram: Optional[str] = None
+    __eci: Optional[int] = None
+    __network_token: Optional[str] = None
+    __scheme_token_requestor_id: Optional[str] = None
+    __token_expiry_date: Optional[str] = None
+
+    @property
+    def cardholder_name(self) -> Optional[str]:
+        """
+        | The card holder's name on the card associated with the Network Token.
+
+        Type: str
+        """
+        return self.__cardholder_name
+
+    @cardholder_name.setter
+    def cardholder_name(self, value: Optional[str]) -> None:
+        self.__cardholder_name = value
+
+    @property
+    def cryptogram(self) -> Optional[str]:
+        """
+        | The Token Cryptogram is a dynamic one-time use value that is used to verify the authenticity of the transaction and the integrity of the data used in the generation of the Token Cryptogram. Visa calls this the Token Authentication Verification Value (TAVV) cryptogram.
+
+        Type: str
+        """
+        return self.__cryptogram
+
+    @cryptogram.setter
+    def cryptogram(self, value: Optional[str]) -> None:
+        self.__cryptogram = value
+
+    @property
+    def eci(self) -> Optional[int]:
+        """
+        | The Electronic Commerce Indicator linked to the Token Cryptogram that is provided by the token service provider during the generation of the Token Cryptogram.
+
+        Type: int
+        """
+        return self.__eci
+
+    @eci.setter
+    def eci(self, value: Optional[int]) -> None:
+        self.__eci = value
+
+    @property
+    def network_token(self) -> Optional[str]:
+        """
+        | Payment Token associated with the Card used for the purchase. Note: This is called Payment Token in the EMVCo documentation.
+
+        Type: str
+        """
+        return self.__network_token
+
+    @network_token.setter
+    def network_token(self, value: Optional[str]) -> None:
+        self.__network_token = value
+
+    @property
+    def scheme_token_requestor_id(self) -> Optional[str]:
+        """
+        | Token Requestor Identifier used with the token service provider during the creation of the Network Token. Depending on the acquirer, this data might be required in the authorization request. We advise you to provide it for all Network Token initiated transactions.
+
+        Type: str
+        """
+        return self.__scheme_token_requestor_id
+
+    @scheme_token_requestor_id.setter
+    def scheme_token_requestor_id(self, value: Optional[str]) -> None:
+        self.__scheme_token_requestor_id = value
+
+    @property
+    def token_expiry_date(self) -> Optional[str]:
+        """
+        | The expiry date of the network token. Format: MMYY
+
+        Type: str
+        """
+        return self.__token_expiry_date
+
+    @token_expiry_date.setter
+    def token_expiry_date(self, value: Optional[str]) -> None:
+        self.__token_expiry_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(NetworkTokenData, self).to_dictionary()
+        if self.cardholder_name is not None:
+            dictionary['cardholderName'] = self.cardholder_name
+        if self.cryptogram is not None:
+            dictionary['cryptogram'] = self.cryptogram
+        if self.eci is not None:
+            dictionary['eci'] = self.eci
+        if self.network_token is not None:
+            dictionary['networkToken'] = self.network_token
+        if self.scheme_token_requestor_id is not None:
+            dictionary['schemeTokenRequestorId'] = self.scheme_token_requestor_id
+        if self.token_expiry_date is not None:
+            dictionary['tokenExpiryDate'] = self.token_expiry_date
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'NetworkTokenData':
+        super(NetworkTokenData, self).from_dictionary(dictionary)
+        if 'cardholderName' in dictionary:
+            self.cardholder_name = dictionary['cardholderName']
+        if 'cryptogram' in dictionary:
+            self.cryptogram = dictionary['cryptogram']
+        if 'eci' in dictionary:
+            self.eci = dictionary['eci']
+        if 'networkToken' in dictionary:
+            self.network_token = dictionary['networkToken']
+        if 'schemeTokenRequestorId' in dictionary:
+            self.scheme_token_requestor_id = dictionary['schemeTokenRequestorId']
+        if 'tokenExpiryDate' in dictionary:
+            self.token_expiry_date = dictionary['tokenExpiryDate']
+        return self

onlinepayments/sdk/domain/network_token_essentials.py

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class NetworkTokenEssentials(DataObject):
+
+    __bin: Optional[str] = None
+    __country_code: Optional[str] = None
+    __network_token: Optional[str] = None
+    __network_token_state: Optional[str] = None
+    __network_token_used: Optional[bool] = None
+    __token_expiry_date: Optional[str] = None
+
+    @property
+    def bin(self) -> Optional[str]:
+        """
+        | The first digits of the network token number from left to right with a minimum of 6 digits.
+
+        Type: str
+        """
+        return self.__bin
+
+    @bin.setter
+    def bin(self, value: Optional[str]) -> None:
+        self.__bin = value
+
+    @property
+    def country_code(self) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code
+
+        Type: str
+        """
+        return self.__country_code
+
+    @country_code.setter
+    def country_code(self, value: Optional[str]) -> None:
+        self.__country_code = value
+
+    @property
+    def network_token(self) -> Optional[str]:
+        """
+        | The masked Payment Token associated with the Card used for the purchase. Note: This is called Payment Token in the EMVCo documentation.
+
+        Type: str
+        """
+        return self.__network_token
+
+    @network_token.setter
+    def network_token(self, value: Optional[str]) -> None:
+        self.__network_token = value
+
+    @property
+    def network_token_state(self) -> Optional[str]:
+        """
+        | Describes the state of the linked network token:
+        
+        * requested - A Network Token has been requested from the scheme.
+        * denied - A Network Token request has been denied from the scheme.
+        * active - The linked Network Token is active and can be used for the subsequent payment in the payment series.
+        * suspended - The linked Network Token is suspended and can not be used for the subsequent payment in the payment series. Instead PAN details would be used for the subsequent payment in the payment series.
+        * deleted - The linked Network Token is deleted and can not be used for the subsequent payment in the payment series. Instead PAN details would be used for the subsequent payment in the payment series.
+        * failed - An attempt was made to request a Network Token, but it was not successful.
+
+        Type: str
+        """
+        return self.__network_token_state
+
+    @network_token_state.setter
+    def network_token_state(self, value: Optional[str]) -> None:
+        self.__network_token_state = value
+
+    @property
+    def network_token_used(self) -> Optional[bool]:
+        """
+        | Whether or not a network token was used in the transaction
+
+        Type: bool
+        """
+        return self.__network_token_used
+
+    @network_token_used.setter
+    def network_token_used(self, value: Optional[bool]) -> None:
+        self.__network_token_used = value
+
+    @property
+    def token_expiry_date(self) -> Optional[str]:
+        """
+        | The expiry date of the network token. Format: MMYY
+
+        Type: str
+        """
+        return self.__token_expiry_date
+
+    @token_expiry_date.setter
+    def token_expiry_date(self, value: Optional[str]) -> None:
+        self.__token_expiry_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(NetworkTokenEssentials, self).to_dictionary()
+        if self.bin is not None:
+            dictionary['bin'] = self.bin
+        if self.country_code is not None:
+            dictionary['countryCode'] = self.country_code
+        if self.network_token is not None:
+            dictionary['networkToken'] = self.network_token
+        if self.network_token_state is not None:
+            dictionary['networkTokenState'] = self.network_token_state
+        if self.network_token_used is not None:
+            dictionary['networkTokenUsed'] = self.network_token_used
+        if self.token_expiry_date is not None:
+            dictionary['tokenExpiryDate'] = self.token_expiry_date
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'NetworkTokenEssentials':
+        super(NetworkTokenEssentials, self).from_dictionary(dictionary)
+        if 'bin' in dictionary:
+            self.bin = dictionary['bin']
+        if 'countryCode' in dictionary:
+            self.country_code = dictionary['countryCode']
+        if 'networkToken' in dictionary:
+            self.network_token = dictionary['networkToken']
+        if 'networkTokenState' in dictionary:
+            self.network_token_state = dictionary['networkTokenState']
+        if 'networkTokenUsed' in dictionary:
+            self.network_token_used = dictionary['networkTokenUsed']
+        if 'tokenExpiryDate' in dictionary:
+            self.token_expiry_date = dictionary['tokenExpiryDate']
+        return self

onlinepayments/sdk/domain/network_token_linked.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class NetworkTokenLinked(DataObject):
+
+    __expiry_date: Optional[str] = None
+    __masked_token: Optional[str] = None
+    __token_state: Optional[str] = None
+
+    @property
+    def expiry_date(self) -> Optional[str]:
+        """
+        | The expiry date of the network token. Format: MMYY
+
+        Type: str
+        """
+        return self.__expiry_date
+
+    @expiry_date.setter
+    def expiry_date(self, value: Optional[str]) -> None:
+        self.__expiry_date = value
+
+    @property
+    def masked_token(self) -> Optional[str]:
+        """
+        | The masked Payment Token associated with the Card used for the purchase. Note: This is called Payment Token in the EMVCo documentation.
+
+        Type: str
+        """
+        return self.__masked_token
+
+    @masked_token.setter
+    def masked_token(self, value: Optional[str]) -> None:
+        self.__masked_token = value
+
+    @property
+    def token_state(self) -> Optional[str]:
+        """
+        | Describes the state of the linked network token:
+        
+        * requested - A Network Token has been requested from the scheme.
+        * denied - A Network Token request has been denied from the scheme.
+        * active - The linked Network Token is active and can be used for the subsequent payment in the payment series.
+        * suspended - The linked Network Token is suspended and can not be used for the subsequent payment in the payment series. Instead PAN details would be used for the subsequent payment in the payment series.
+        * deleted - The linked Network Token is deleted and can not be used for the subsequent payment in the payment series. Instead PAN details would be used for the subsequent payment in the payment series.
+        * failed - An attempt was made to request a Network Token, but it was not successful.
+
+        Type: str
+        """
+        return self.__token_state
+
+    @token_state.setter
+    def token_state(self, value: Optional[str]) -> None:
+        self.__token_state = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(NetworkTokenLinked, self).to_dictionary()
+        if self.expiry_date is not None:
+            dictionary['expiryDate'] = self.expiry_date
+        if self.masked_token is not None:
+            dictionary['maskedToken'] = self.masked_token
+        if self.token_state is not None:
+            dictionary['tokenState'] = self.token_state
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'NetworkTokenLinked':
+        super(NetworkTokenLinked, self).from_dictionary(dictionary)
+        if 'expiryDate' in dictionary:
+            self.expiry_date = dictionary['expiryDate']
+        if 'maskedToken' in dictionary:
+            self.masked_token = dictionary['maskedToken']
+        if 'tokenState' in dictionary:
+            self.token_state = dictionary['tokenState']
+        return self

onlinepayments/sdk/domain/omnichannel_payment_specific_input.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OmnichannelPaymentSpecificInput(DataObject):
+
+    __operator_id: Optional[str] = None
+
+    @property
+    def operator_id(self) -> Optional[str]:
+        """
+        | Merchants may optionally include a user identifier to indicate which person within their organization initiated this request, enabling detailed audit trails and transaction accountability. If not provided, the field defaults to the merchant ID.
+
+        Type: str
+        """
+        return self.__operator_id
+
+    @operator_id.setter
+    def operator_id(self, value: Optional[str]) -> None:
+        self.__operator_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OmnichannelPaymentSpecificInput, self).to_dictionary()
+        if self.operator_id is not None:
+            dictionary['operatorId'] = self.operator_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OmnichannelPaymentSpecificInput':
+        super(OmnichannelPaymentSpecificInput, self).from_dictionary(dictionary)
+        if 'operatorId' in dictionary:
+            self.operator_id = dictionary['operatorId']
+        return self

onlinepayments/sdk/domain/omnichannel_payout_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 OmnichannelPayoutSpecificInput(DataObject):
+
+    __operator_id: Optional[str] = None
+    __payment_id: Optional[str] = None
+
+    @property
+    def operator_id(self) -> Optional[str]:
+        """
+        | Merchants may optionally include a user identifier to indicate which person within their organization initiated this request, enabling detailed audit trails and transaction accountability. If not provided, the field defaults to the merchant ID.
+
+        Type: str
+        """
+        return self.__operator_id
+
+    @operator_id.setter
+    def operator_id(self, value: Optional[str]) -> None:
+        self.__operator_id = value
+
+    @property
+    def payment_id(self) -> Optional[str]:
+        """
+        | The Payment Id of the transaction (either in-store or online), from which you request to make a refund.
+
+        Type: str
+        """
+        return self.__payment_id
+
+    @payment_id.setter
+    def payment_id(self, value: Optional[str]) -> None:
+        self.__payment_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OmnichannelPayoutSpecificInput, self).to_dictionary()
+        if self.operator_id is not None:
+            dictionary['operatorId'] = self.operator_id
+        if self.payment_id is not None:
+            dictionary['paymentId'] = self.payment_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OmnichannelPayoutSpecificInput':
+        super(OmnichannelPayoutSpecificInput, self).from_dictionary(dictionary)
+        if 'operatorId' in dictionary:
+            self.operator_id = dictionary['operatorId']
+        if 'paymentId' in dictionary:
+            self.payment_id = dictionary['paymentId']
+        return self

onlinepayments/sdk/domain/omnichannel_refund_specific_input.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OmnichannelRefundSpecificInput(DataObject):
+
+    __operator_id: Optional[str] = None
+
+    @property
+    def operator_id(self) -> Optional[str]:
+        """
+        | Merchants may optionally include a user identifier to indicate which person within their organization initiated this request, enabling detailed audit trails and transaction accountability. If not provided, the field defaults to the merchant ID.
+
+        Type: str
+        """
+        return self.__operator_id
+
+    @operator_id.setter
+    def operator_id(self, value: Optional[str]) -> None:
+        self.__operator_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OmnichannelRefundSpecificInput, self).to_dictionary()
+        if self.operator_id is not None:
+            dictionary['operatorId'] = self.operator_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OmnichannelRefundSpecificInput':
+        super(OmnichannelRefundSpecificInput, self).from_dictionary(dictionary)
+        if 'operatorId' in dictionary:
+            self.operator_id = dictionary['operatorId']
+        return self

onlinepayments/sdk/domain/omnichannel_subsequent_specific_input.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OmnichannelSubsequentSpecificInput(DataObject):
+
+    __operator_id: Optional[str] = None
+
+    @property
+    def operator_id(self) -> Optional[str]:
+        """
+        | Merchants may optionally include a user identifier to indicate which person within their organization initiated this request, enabling detailed audit trails and transaction accountability. If not provided, the field defaults to the merchant ID.
+
+        Type: str
+        """
+        return self.__operator_id
+
+    @operator_id.setter
+    def operator_id(self, value: Optional[str]) -> None:
+        self.__operator_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OmnichannelSubsequentSpecificInput, self).to_dictionary()
+        if self.operator_id is not None:
+            dictionary['operatorId'] = self.operator_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OmnichannelSubsequentSpecificInput':
+        super(OmnichannelSubsequentSpecificInput, self).from_dictionary(dictionary)
+        if 'operatorId' in dictionary:
+            self.operator_id = dictionary['operatorId']
+        return self