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

onlinepayments/sdk/domain/surcharge_for_payment_link.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class SurchargeForPaymentLink(DataObject):
+
+    __surcharge_mode: Optional[str] = None
+
+    @property
+    def surcharge_mode(self) -> Optional[str]:
+        """
+        | The surcharge mode which defines how a merchant will apply surcharging.
+        
+        * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
+        * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
+
+        Type: str
+        """
+        return self.__surcharge_mode
+
+    @surcharge_mode.setter
+    def surcharge_mode(self, value: Optional[str]) -> None:
+        self.__surcharge_mode = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SurchargeForPaymentLink, self).to_dictionary()
+        if self.surcharge_mode is not None:
+            dictionary['surchargeMode'] = self.surcharge_mode
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeForPaymentLink':
+        super(SurchargeForPaymentLink, self).from_dictionary(dictionary)
+        if 'surchargeMode' in dictionary:
+            self.surcharge_mode = dictionary['surchargeMode']
+        return self

onlinepayments/sdk/domain/surcharge_rate.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class SurchargeRate(DataObject):
+
+    __ad_valorem_rate: Optional[float] = None
+    __specific_rate: Optional[int] = None
+    __surcharge_product_type_id: Optional[str] = None
+    __surcharge_product_type_version: Optional[str] = None
+
+    @property
+    def ad_valorem_rate(self) -> Optional[float]:
+        """
+        | A percentage rate defined on a merchant's configuration used in the calculation of a surcharge amount.
+
+        Type: float
+        """
+        return self.__ad_valorem_rate
+
+    @ad_valorem_rate.setter
+    def ad_valorem_rate(self, value: Optional[float]) -> None:
+        self.__ad_valorem_rate = value
+
+    @property
+    def specific_rate(self) -> Optional[int]:
+        """
+        | A specific, fixed rate in cents defined on a merchant's configuration that is used in the calculation of a surcharge amount.
+
+        Type: int
+        """
+        return self.__specific_rate
+
+    @specific_rate.setter
+    def specific_rate(self, value: Optional[int]) -> None:
+        self.__specific_rate = value
+
+    @property
+    def surcharge_product_type_id(self) -> Optional[str]:
+        """
+        | The name of the applicable surcharge rates for the relevant payment product
+
+        Type: str
+        """
+        return self.__surcharge_product_type_id
+
+    @surcharge_product_type_id.setter
+    def surcharge_product_type_id(self, value: Optional[str]) -> None:
+        self.__surcharge_product_type_id = value
+
+    @property
+    def surcharge_product_type_version(self) -> Optional[str]:
+        """
+        | A specific version identifier of the surcharge rates as applied for this request
+
+        Type: str
+        """
+        return self.__surcharge_product_type_version
+
+    @surcharge_product_type_version.setter
+    def surcharge_product_type_version(self, value: Optional[str]) -> None:
+        self.__surcharge_product_type_version = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SurchargeRate, self).to_dictionary()
+        if self.ad_valorem_rate is not None:
+            dictionary['adValoremRate'] = self.ad_valorem_rate
+        if self.specific_rate is not None:
+            dictionary['specificRate'] = self.specific_rate
+        if self.surcharge_product_type_id is not None:
+            dictionary['surchargeProductTypeId'] = self.surcharge_product_type_id
+        if self.surcharge_product_type_version is not None:
+            dictionary['surchargeProductTypeVersion'] = self.surcharge_product_type_version
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeRate':
+        super(SurchargeRate, self).from_dictionary(dictionary)
+        if 'adValoremRate' in dictionary:
+            self.ad_valorem_rate = dictionary['adValoremRate']
+        if 'specificRate' in dictionary:
+            self.specific_rate = dictionary['specificRate']
+        if 'surchargeProductTypeId' in dictionary:
+            self.surcharge_product_type_id = dictionary['surchargeProductTypeId']
+        if 'surchargeProductTypeVersion' in dictionary:
+            self.surcharge_product_type_version = dictionary['surchargeProductTypeVersion']
+        return self

onlinepayments/sdk/domain/surcharge_specific_input.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+
+
+class SurchargeSpecificInput(DataObject):
+
+    __mode: Optional[str] = None
+    __surcharge_amount: Optional[AmountOfMoney] = None
+
+    @property
+    def mode(self) -> Optional[str]:
+        """
+        | The surcharge mode which defines how a merchant will apply surcharging.
+        
+        * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
+        * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
+
+        Type: str
+        """
+        return self.__mode
+
+    @mode.setter
+    def mode(self, value: Optional[str]) -> None:
+        self.__mode = value
+
+    @property
+    def surcharge_amount(self) -> Optional[AmountOfMoney]:
+        """
+        | Object containing amount and ISO currency code attributes
+
+        Type: :class:`onlinepayments.sdk.domain.amount_of_money.AmountOfMoney`
+        """
+        return self.__surcharge_amount
+
+    @surcharge_amount.setter
+    def surcharge_amount(self, value: Optional[AmountOfMoney]) -> None:
+        self.__surcharge_amount = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SurchargeSpecificInput, self).to_dictionary()
+        if self.mode is not None:
+            dictionary['mode'] = self.mode
+        if self.surcharge_amount is not None:
+            dictionary['surchargeAmount'] = self.surcharge_amount.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeSpecificInput':
+        super(SurchargeSpecificInput, self).from_dictionary(dictionary)
+        if 'mode' in dictionary:
+            self.mode = dictionary['mode']
+        if 'surchargeAmount' in dictionary:
+            if not isinstance(dictionary['surchargeAmount'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['surchargeAmount']))
+            value = AmountOfMoney()
+            self.surcharge_amount = value.from_dictionary(dictionary['surchargeAmount'])
+        return self

onlinepayments/sdk/domain/surcharge_specific_output.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+from .surcharge_rate import SurchargeRate
+
+
+class SurchargeSpecificOutput(DataObject):
+
+    __mode: Optional[str] = None
+    __surcharge_amount: Optional[AmountOfMoney] = None
+    __surcharge_rate: Optional[SurchargeRate] = None
+
+    @property
+    def mode(self) -> Optional[str]:
+        """
+        | The surcharge mode which defines how a merchant will apply surcharging.
+        
+        * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
+        * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
+
+        Type: str
+        """
+        return self.__mode
+
+    @mode.setter
+    def mode(self, value: Optional[str]) -> None:
+        self.__mode = value
+
+    @property
+    def surcharge_amount(self) -> Optional[AmountOfMoney]:
+        """
+        | Object containing amount and ISO currency code attributes
+
+        Type: :class:`onlinepayments.sdk.domain.amount_of_money.AmountOfMoney`
+        """
+        return self.__surcharge_amount
+
+    @surcharge_amount.setter
+    def surcharge_amount(self, value: Optional[AmountOfMoney]) -> None:
+        self.__surcharge_amount = value
+
+    @property
+    def surcharge_rate(self) -> Optional[SurchargeRate]:
+        """
+        | A summary of surcharge details used in the calculation of the surcharge amount. null if result = NO_SURCHARGE
+
+        Type: :class:`onlinepayments.sdk.domain.surcharge_rate.SurchargeRate`
+        """
+        return self.__surcharge_rate
+
+    @surcharge_rate.setter
+    def surcharge_rate(self, value: Optional[SurchargeRate]) -> None:
+        self.__surcharge_rate = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SurchargeSpecificOutput, self).to_dictionary()
+        if self.mode is not None:
+            dictionary['mode'] = self.mode
+        if self.surcharge_amount is not None:
+            dictionary['surchargeAmount'] = self.surcharge_amount.to_dictionary()
+        if self.surcharge_rate is not None:
+            dictionary['surchargeRate'] = self.surcharge_rate.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeSpecificOutput':
+        super(SurchargeSpecificOutput, self).from_dictionary(dictionary)
+        if 'mode' in dictionary:
+            self.mode = dictionary['mode']
+        if 'surchargeAmount' in dictionary:
+            if not isinstance(dictionary['surchargeAmount'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['surchargeAmount']))
+            value = AmountOfMoney()
+            self.surcharge_amount = value.from_dictionary(dictionary['surchargeAmount'])
+        if 'surchargeRate' in dictionary:
+            if not isinstance(dictionary['surchargeRate'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['surchargeRate']))
+            value = SurchargeRate()
+            self.surcharge_rate = value.from_dictionary(dictionary['surchargeRate'])
+        return self

onlinepayments/sdk/domain/test_connection.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class TestConnection(DataObject):
+
+    __result: Optional[str] = None
+
+    @property
+    def result(self) -> Optional[str]:
+        """
+        Type: str
+        """
+        return self.__result
+
+    @result.setter
+    def result(self, value: Optional[str]) -> None:
+        self.__result = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(TestConnection, self).to_dictionary()
+        if self.result is not None:
+            dictionary['result'] = self.result
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'TestConnection':
+        super(TestConnection, self).from_dictionary(dictionary)
+        if 'result' in dictionary:
+            self.result = dictionary['result']
+        return self

onlinepayments/sdk/domain/three_d_secure.py

@@ -0,0 +1,281 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .external_cardholder_authentication_data import ExternalCardholderAuthenticationData
+from .redirection_data import RedirectionData
+from .three_d_secure_data import ThreeDSecureData
+
+
+class ThreeDSecure(DataObject):
+
+    __authentication_amount: Optional[int] = None
+    __challenge_canvas_size: Optional[str] = None
+    __challenge_indicator: Optional[str] = None
+    __device_channel: Optional[str] = None
+    __exemption_request: Optional[str] = None
+    __external_cardholder_authentication_data: Optional[ExternalCardholderAuthenticationData] = None
+    __merchant_fraud_rate: Optional[int] = None
+    __prior_three_d_secure_data: Optional[ThreeDSecureData] = None
+    __redirection_data: Optional[RedirectionData] = 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 device_channel(self) -> Optional[str]:
+        """
+        | Determines whether the call is coming from an application or from a browser * AppBased - Call is coming from an application. * Browser - Call is coming from a browser
+
+        Type: str
+        """
+        return self.__device_channel
+
+    @device_channel.setter
+    def device_channel(self, value: Optional[str]) -> None:
+        self.__device_channel = 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 external_cardholder_authentication_data(self) -> Optional[ExternalCardholderAuthenticationData]:
+        """
+        | Object containing 3D secure details.
+
+        Type: :class:`onlinepayments.sdk.domain.external_cardholder_authentication_data.ExternalCardholderAuthenticationData`
+        """
+        return self.__external_cardholder_authentication_data
+
+    @external_cardholder_authentication_data.setter
+    def external_cardholder_authentication_data(self, value: Optional[ExternalCardholderAuthenticationData]) -> None:
+        self.__external_cardholder_authentication_data = 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 redirection_data(self) -> Optional[RedirectionData]:
+        """
+        | Object containing browser specific redirection related data
+
+        Type: :class:`onlinepayments.sdk.domain.redirection_data.RedirectionData`
+        """
+        return self.__redirection_data
+
+    @redirection_data.setter
+    def redirection_data(self, value: Optional[RedirectionData]) -> None:
+        self.__redirection_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(ThreeDSecure, 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.device_channel is not None:
+            dictionary['deviceChannel'] = self.device_channel
+        if self.exemption_request is not None:
+            dictionary['exemptionRequest'] = self.exemption_request
+        if self.external_cardholder_authentication_data is not None:
+            dictionary['externalCardholderAuthenticationData'] = self.external_cardholder_authentication_data.to_dictionary()
+        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.redirection_data is not None:
+            dictionary['redirectionData'] = self.redirection_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) -> 'ThreeDSecure':
+        super(ThreeDSecure, 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 'deviceChannel' in dictionary:
+            self.device_channel = dictionary['deviceChannel']
+        if 'exemptionRequest' in dictionary:
+            self.exemption_request = dictionary['exemptionRequest']
+        if 'externalCardholderAuthenticationData' in dictionary:
+            if not isinstance(dictionary['externalCardholderAuthenticationData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['externalCardholderAuthenticationData']))
+            value = ExternalCardholderAuthenticationData()
+            self.external_cardholder_authentication_data = value.from_dictionary(dictionary['externalCardholderAuthenticationData'])
+        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 'redirectionData' in dictionary:
+            if not isinstance(dictionary['redirectionData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['redirectionData']))
+            value = RedirectionData()
+            self.redirection_data = value.from_dictionary(dictionary['redirectionData'])
+        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