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

onlinepayments/sdk/domain/three_d_secure_base.py

@@ -0,0 +1,219 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .three_d_secure_data import ThreeDSecureData
+
+
+class ThreeDSecureBase(DataObject):
+
+    __authentication_amount: Optional[int] = None
+    __challenge_canvas_size: Optional[str] = None
+    __challenge_indicator: Optional[str] = None
+    __exemption_request: Optional[str] = None
+    __merchant_fraud_rate: Optional[int] = None
+    __prior_three_d_secure_data: Optional[ThreeDSecureData] = None
+    __secure_corporate_payment: Optional[bool] = None
+    __skip_authentication: Optional[bool] = None
+    __skip_soft_decline: Optional[bool] = None
+
+    @property
+    def authentication_amount(self) -> Optional[int]:
+        """
+        | The amount to be authenticated. This field should be populated if the amount to be authenticated differs from the amount to be authorized (by default they are considered equal). Amount in cents and always having 2 decimals.
+
+        Type: int
+        """
+        return self.__authentication_amount
+
+    @authentication_amount.setter
+    def authentication_amount(self, value: Optional[int]) -> None:
+        self.__authentication_amount = value
+
+    @property
+    def challenge_canvas_size(self) -> Optional[str]:
+        """
+        | Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are
+        
+        * 250x400 (default)
+        * 390x400
+        * 500x600
+        * 600x400
+        * full-screen
+
+        Type: str
+        """
+        return self.__challenge_canvas_size
+
+    @challenge_canvas_size.setter
+    def challenge_canvas_size(self, value: Optional[str]) -> None:
+        self.__challenge_canvas_size = value
+
+    @property
+    def challenge_indicator(self) -> Optional[str]:
+        """
+        | Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values:
+        
+        * no-preference - You have no preference whether or not to challenge the customer (default)
+        * no-challenge-requested - you prefer the cardholder not to be challenged
+        * challenge-requested - you prefer the customer to be challenged
+        * challenge-required - you require the customer to be challenged
+        * no-challenge-requested-risk-analysis-performed – letting the issuer know that you have already assessed the transaction with fraud prevention tool
+        * no-challenge-requested-data-share-only – sharing data only with the DS
+        * no-challenge-requested-consumer-authentication-performed – authentication already happened at your side – when login in to your website
+        * no-challenge-requested-use-whitelist-exemption – cardholder has whitelisted you at with the issuer
+        * challenge-requested-whitelist-prompt-requested – cardholder is trying to whitelist you
+        * request-scoring-without-connecting-to-acs – sending information to CB DS for a fraud scoring
+
+        Type: str
+        """
+        return self.__challenge_indicator
+
+    @challenge_indicator.setter
+    def challenge_indicator(self, value: Optional[str]) -> None:
+        self.__challenge_indicator = value
+
+    @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.
+        
+        * none = No exemption requested
+        * transaction-risk-analysis = Fraud analysis has been done already by your own fraud module and transaction scored as low risk
+        * low-value = Bellow 30 euros
+        * whitelist = The cardholder has whitelisted you with their issuer
+
+        Type: str
+        """
+        return self.__exemption_request
+
+    @exemption_request.setter
+    def exemption_request(self, value: Optional[str]) -> None:
+        self.__exemption_request = value
+
+    @property
+    def merchant_fraud_rate(self) -> Optional[int]:
+        """
+        | The merchant fraud rate in the EEA is calculated as the total EEA card fraud divided by all EEA card volumes, as per PSD2 RTS. Mastercard will not calculate or validate the merchant fraud score. Accepted values are:
+        
+        * 1 - represents a fraud rate less than or equal to 1 basis point (bp), which is 0.01%.
+        * 2 - represents a fraud rate between 1 bp and 6 bps.
+        * 3 - represents a fraud rate between 6 bps and 13 bps.
+        * 4 - represents a fraud rate between 13 bps and 25 bps.
+        * 5 - represents a fraud rate greater than 25 bps.
+
+        Type: int
+        """
+        return self.__merchant_fraud_rate
+
+    @merchant_fraud_rate.setter
+    def merchant_fraud_rate(self, value: Optional[int]) -> None:
+        self.__merchant_fraud_rate = value
+
+    @property
+    def prior_three_d_secure_data(self) -> Optional[ThreeDSecureData]:
+        """
+        | Object containing data regarding the customer authentication that occurred prior to the current transaction
+
+        Type: :class:`onlinepayments.sdk.domain.three_d_secure_data.ThreeDSecureData`
+        """
+        return self.__prior_three_d_secure_data
+
+    @prior_three_d_secure_data.setter
+    def prior_three_d_secure_data(self, value: Optional[ThreeDSecureData]) -> None:
+        self.__prior_three_d_secure_data = value
+
+    @property
+    def secure_corporate_payment(self) -> Optional[bool]:
+        """
+        | Indicates that dedicated payment processes and procedures were used. A potential secure corporate payment exemption applies. Logically, this field should only be set to 'yes' if the acquirer exemption field is blank. A merchant cannot claim both acquirer exemption and secure payment. However, the DS will not validate the conditions in the extension; DS will pass data as presented.
+
+        Type: bool
+        """
+        return self.__secure_corporate_payment
+
+    @secure_corporate_payment.setter
+    def secure_corporate_payment(self, value: Optional[bool]) -> None:
+        self.__secure_corporate_payment = value
+
+    @property
+    def skip_authentication(self) -> Optional[bool]:
+        """
+        * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to "recurring"
+        * false = 3D Secure authentication will not be skipped for this transaction
+        
+        | Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction
+
+        Type: bool
+        """
+        return self.__skip_authentication
+
+    @skip_authentication.setter
+    def skip_authentication(self, value: Optional[bool]) -> None:
+        self.__skip_authentication = value
+
+    @property
+    def skip_soft_decline(self) -> Optional[bool]:
+        """
+        * true = Soft Decline retry mechanism will be skipped for this transaction. The transaction will result in "Authorization Declined" status. This setting should be used when skipAuthentication is set to true and the merchant does not want to use Soft Decline retry mechanism.
+        * false = Soft Decline retry mechanism will not be skipped for this transaction.
+        
+        | Note: skipSoftDecline defaults to false if empty. This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
+
+        Type: bool
+        """
+        return self.__skip_soft_decline
+
+    @skip_soft_decline.setter
+    def skip_soft_decline(self, value: Optional[bool]) -> None:
+        self.__skip_soft_decline = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ThreeDSecureBase, self).to_dictionary()
+        if self.authentication_amount is not None:
+            dictionary['authenticationAmount'] = self.authentication_amount
+        if self.challenge_canvas_size is not None:
+            dictionary['challengeCanvasSize'] = self.challenge_canvas_size
+        if self.challenge_indicator is not None:
+            dictionary['challengeIndicator'] = self.challenge_indicator
+        if self.exemption_request is not None:
+            dictionary['exemptionRequest'] = self.exemption_request
+        if self.merchant_fraud_rate is not None:
+            dictionary['merchantFraudRate'] = self.merchant_fraud_rate
+        if self.prior_three_d_secure_data is not None:
+            dictionary['priorThreeDSecureData'] = self.prior_three_d_secure_data.to_dictionary()
+        if self.secure_corporate_payment is not None:
+            dictionary['secureCorporatePayment'] = self.secure_corporate_payment
+        if self.skip_authentication is not None:
+            dictionary['skipAuthentication'] = self.skip_authentication
+        if self.skip_soft_decline is not None:
+            dictionary['skipSoftDecline'] = self.skip_soft_decline
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ThreeDSecureBase':
+        super(ThreeDSecureBase, self).from_dictionary(dictionary)
+        if 'authenticationAmount' in dictionary:
+            self.authentication_amount = dictionary['authenticationAmount']
+        if 'challengeCanvasSize' in dictionary:
+            self.challenge_canvas_size = dictionary['challengeCanvasSize']
+        if 'challengeIndicator' in dictionary:
+            self.challenge_indicator = dictionary['challengeIndicator']
+        if 'exemptionRequest' in dictionary:
+            self.exemption_request = dictionary['exemptionRequest']
+        if 'merchantFraudRate' in dictionary:
+            self.merchant_fraud_rate = dictionary['merchantFraudRate']
+        if 'priorThreeDSecureData' in dictionary:
+            if not isinstance(dictionary['priorThreeDSecureData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['priorThreeDSecureData']))
+            value = ThreeDSecureData()
+            self.prior_three_d_secure_data = value.from_dictionary(dictionary['priorThreeDSecureData'])
+        if 'secureCorporatePayment' in dictionary:
+            self.secure_corporate_payment = dictionary['secureCorporatePayment']
+        if 'skipAuthentication' in dictionary:
+            self.skip_authentication = dictionary['skipAuthentication']
+        if 'skipSoftDecline' in dictionary:
+            self.skip_soft_decline = dictionary['skipSoftDecline']
+        return self

onlinepayments/sdk/domain/three_d_secure_data.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class ThreeDSecureData(DataObject):
+
+    __acs_transaction_id: Optional[str] = None
+    __method: Optional[str] = None
+    __utc_timestamp: Optional[str] = None
+
+    @property
+    def acs_transaction_id(self) -> Optional[str]:
+        """
+        | The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
+
+        Type: str
+        """
+        return self.__acs_transaction_id
+
+    @acs_transaction_id.setter
+    def acs_transaction_id(self, value: Optional[str]) -> None:
+        self.__acs_transaction_id = value
+
+    @property
+    def method(self) -> Optional[str]:
+        """
+        | Method of authentication used for this transaction. Possible values:
+        
+        * frictionless = The authentication went without a challenge
+        * challenged = Cardholder was challenged
+        * avs-verified = The authentication was verified by AVS
+        * other = Another issuer method was used to authenticate this transaction
+
+        Type: str
+        """
+        return self.__method
+
+    @method.setter
+    def method(self, value: Optional[str]) -> None:
+        self.__method = value
+
+    @property
+    def utc_timestamp(self) -> Optional[str]:
+        """
+        | Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
+
+        Type: str
+        """
+        return self.__utc_timestamp
+
+    @utc_timestamp.setter
+    def utc_timestamp(self, value: Optional[str]) -> None:
+        self.__utc_timestamp = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ThreeDSecureData, self).to_dictionary()
+        if self.acs_transaction_id is not None:
+            dictionary['acsTransactionId'] = self.acs_transaction_id
+        if self.method is not None:
+            dictionary['method'] = self.method
+        if self.utc_timestamp is not None:
+            dictionary['utcTimestamp'] = self.utc_timestamp
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ThreeDSecureData':
+        super(ThreeDSecureData, self).from_dictionary(dictionary)
+        if 'acsTransactionId' in dictionary:
+            self.acs_transaction_id = dictionary['acsTransactionId']
+        if 'method' in dictionary:
+            self.method = dictionary['method']
+        if 'utcTimestamp' in dictionary:
+            self.utc_timestamp = dictionary['utcTimestamp']
+        return self

onlinepayments/sdk/domain/three_d_secure_results.py

@@ -0,0 +1,266 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class ThreeDSecureResults(DataObject):
+
+    __acs_transaction_id: Optional[str] = None
+    __applied_exemption: Optional[str] = None
+    __authentication_status: Optional[str] = None
+    __cavv: Optional[str] = None
+    __challenge_indicator: Optional[str] = None
+    __ds_transaction_id: Optional[str] = None
+    __eci: Optional[str] = None
+    __exemption_engine_flow: Optional[str] = None
+    __flow: Optional[str] = None
+    __liability: Optional[str] = None
+    __scheme_eci: Optional[str] = None
+    __version: Optional[str] = None
+    __xid: Optional[str] = None
+
+    @property
+    def acs_transaction_id(self) -> Optional[str]:
+        """
+        | Authenticated Transaction Identifier at the ACS/Issuer.
+
+        Type: str
+        """
+        return self.__acs_transaction_id
+
+    @acs_transaction_id.setter
+    def acs_transaction_id(self, value: Optional[str]) -> None:
+        self.__acs_transaction_id = value
+
+    @property
+    def applied_exemption(self) -> Optional[str]:
+        """
+        | Exemption requested and applied in the authorization
+
+        Type: str
+        """
+        return self.__applied_exemption
+
+    @applied_exemption.setter
+    def applied_exemption(self, value: Optional[str]) -> None:
+        self.__applied_exemption = value
+
+    @property
+    def authentication_status(self) -> Optional[str]:
+        """
+        | One-letter authentication status returned by DS. Possible values are:
+        
+        * Y - Authentication succeeded
+        * A - Authentication attempted
+        * I - Information only, liability shifted to the merchant
+        * N - Authentication failed
+        * R - Authentication rejected
+        * U - Authentication unavailable
+        * C - Authentication required
+
+        Type: str
+        """
+        return self.__authentication_status
+
+    @authentication_status.setter
+    def authentication_status(self, value: Optional[str]) -> None:
+        self.__authentication_status = value
+
+    @property
+    def cavv(self) -> Optional[str]:
+        """
+        | Cardholder Authentication Verification Value. End-2-end reference generated by the Issuer to recognize that the authentication has taken place.
+
+        Type: str
+        """
+        return self.__cavv
+
+    @cavv.setter
+    def cavv(self, value: Optional[str]) -> None:
+        self.__cavv = value
+
+    @property
+    def challenge_indicator(self) -> Optional[str]:
+        """
+        | Challenge Indicator used for this transaction. This value might differ from the one sent by the merchant if the card is not supporting it (3DS version 2.1 vs 3DS version 2.2).
+
+        Type: str
+        """
+        return self.__challenge_indicator
+
+    @challenge_indicator.setter
+    def challenge_indicator(self, value: Optional[str]) -> None:
+        self.__challenge_indicator = value
+
+    @property
+    def ds_transaction_id(self) -> Optional[str]:
+        """
+        | 3D Secure Directory Server Transaction Identifier used for this transaction.
+
+        Type: str
+        """
+        return self.__ds_transaction_id
+
+    @ds_transaction_id.setter
+    def ds_transaction_id(self, value: Optional[str]) -> None:
+        self.__ds_transaction_id = value
+
+    @property
+    def eci(self) -> Optional[str]:
+        """
+        | Indicates Authentication validation results returned after AuthenticationValidation
+
+        Type: str
+        """
+        return self.__eci
+
+    @eci.setter
+    def eci(self, value: Optional[str]) -> None:
+        self.__eci = value
+
+    @property
+    def exemption_engine_flow(self) -> Optional[str]:
+        """
+        | Detailed description of the Exemption Engine outcomes
+
+        Type: str
+        """
+        return self.__exemption_engine_flow
+
+    @exemption_engine_flow.setter
+    def exemption_engine_flow(self, value: Optional[str]) -> None:
+        self.__exemption_engine_flow = value
+
+    @property
+    def flow(self) -> Optional[str]:
+        """
+        | 3D Secure Flow used during this transaction.
+
+        Type: str
+        """
+        return self.__flow
+
+    @flow.setter
+    def flow(self, value: Optional[str]) -> None:
+        self.__flow = value
+
+    @property
+    def liability(self) -> Optional[str]:
+        """
+        | Determines the Fraud liability. Possible values are:
+        
+        * issuer - Fraud liability shifts to the issuer
+        * merchant - Fraud liability with the merchant
+        
+        | Note: When not filled in Fraud liability is not applicable for the current transaction.
+
+        Type: str
+        """
+        return self.__liability
+
+    @liability.setter
+    def liability(self, value: Optional[str]) -> None:
+        self.__liability = value
+
+    @property
+    def scheme_eci(self) -> Optional[str]:
+        """
+        | 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme. Returned by DS.
+
+        Type: str
+        """
+        return self.__scheme_eci
+
+    @scheme_eci.setter
+    def scheme_eci(self, value: Optional[str]) -> None:
+        self.__scheme_eci = value
+
+    @property
+    def version(self) -> Optional[str]:
+        """
+        | 3D Secure Protocol version used during this transaction.
+
+        Type: str
+        """
+        return self.__version
+
+    @version.setter
+    def version(self, value: Optional[str]) -> None:
+        self.__version = value
+
+    @property
+    def xid(self) -> Optional[str]:
+        """
+        | Transaction ID for the Authentication
+
+        Type: str
+        """
+        return self.__xid
+
+    @xid.setter
+    def xid(self, value: Optional[str]) -> None:
+        self.__xid = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ThreeDSecureResults, self).to_dictionary()
+        if self.acs_transaction_id is not None:
+            dictionary['acsTransactionId'] = self.acs_transaction_id
+        if self.applied_exemption is not None:
+            dictionary['appliedExemption'] = self.applied_exemption
+        if self.authentication_status is not None:
+            dictionary['authenticationStatus'] = self.authentication_status
+        if self.cavv is not None:
+            dictionary['cavv'] = self.cavv
+        if self.challenge_indicator is not None:
+            dictionary['challengeIndicator'] = self.challenge_indicator
+        if self.ds_transaction_id is not None:
+            dictionary['dsTransactionId'] = self.ds_transaction_id
+        if self.eci is not None:
+            dictionary['eci'] = self.eci
+        if self.exemption_engine_flow is not None:
+            dictionary['exemptionEngineFlow'] = self.exemption_engine_flow
+        if self.flow is not None:
+            dictionary['flow'] = self.flow
+        if self.liability is not None:
+            dictionary['liability'] = self.liability
+        if self.scheme_eci is not None:
+            dictionary['schemeEci'] = self.scheme_eci
+        if self.version is not None:
+            dictionary['version'] = self.version
+        if self.xid is not None:
+            dictionary['xid'] = self.xid
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ThreeDSecureResults':
+        super(ThreeDSecureResults, self).from_dictionary(dictionary)
+        if 'acsTransactionId' in dictionary:
+            self.acs_transaction_id = dictionary['acsTransactionId']
+        if 'appliedExemption' in dictionary:
+            self.applied_exemption = dictionary['appliedExemption']
+        if 'authenticationStatus' in dictionary:
+            self.authentication_status = dictionary['authenticationStatus']
+        if 'cavv' in dictionary:
+            self.cavv = dictionary['cavv']
+        if 'challengeIndicator' in dictionary:
+            self.challenge_indicator = dictionary['challengeIndicator']
+        if 'dsTransactionId' in dictionary:
+            self.ds_transaction_id = dictionary['dsTransactionId']
+        if 'eci' in dictionary:
+            self.eci = dictionary['eci']
+        if 'exemptionEngineFlow' in dictionary:
+            self.exemption_engine_flow = dictionary['exemptionEngineFlow']
+        if 'flow' in dictionary:
+            self.flow = dictionary['flow']
+        if 'liability' in dictionary:
+            self.liability = dictionary['liability']
+        if 'schemeEci' in dictionary:
+            self.scheme_eci = dictionary['schemeEci']
+        if 'version' in dictionary:
+            self.version = dictionary['version']
+        if 'xid' in dictionary:
+            self.xid = dictionary['xid']
+        return self

onlinepayments/sdk/domain/token_card.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .token_card_data import TokenCardData
+
+
+class TokenCard(DataObject):
+
+    __alias: Optional[str] = None
+    __data: Optional[TokenCardData] = None
+
+    @property
+    def alias(self) -> Optional[str]:
+        """
+        | An alias for the token. This can be used to visually represent the token.
+
+        Type: str
+        """
+        return self.__alias
+
+    @alias.setter
+    def alias(self, value: Optional[str]) -> None:
+        self.__alias = value
+
+    @property
+    def data(self) -> Optional[TokenCardData]:
+        """
+        Type: :class:`onlinepayments.sdk.domain.token_card_data.TokenCardData`
+        """
+        return self.__data
+
+    @data.setter
+    def data(self, value: Optional[TokenCardData]) -> None:
+        self.__data = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(TokenCard, self).to_dictionary()
+        if self.alias is not None:
+            dictionary['alias'] = self.alias
+        if self.data is not None:
+            dictionary['data'] = self.data.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'TokenCard':
+        super(TokenCard, self).from_dictionary(dictionary)
+        if 'alias' in dictionary:
+            self.alias = dictionary['alias']
+        if 'data' in dictionary:
+            if not isinstance(dictionary['data'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['data']))
+            value = TokenCardData()
+            self.data = value.from_dictionary(dictionary['data'])
+        return self