Package com.adyen.model.checkout

Class AdditionalDataCommon

  • public class AdditionalDataCommon
extends Object
    AdditionalDataCommon

    • Constructor Detail

      • AdditionalDataCommon

        public AdditionalDataCommon()

    • Method Detail

      • requestedTestErrorResponseCode

        public AdditionalDataCommon requestedTestErrorResponseCode​(String requestedTestErrorResponseCode)
        Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.
        Parameters:
        requestedTestErrorResponseCode -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getRequestedTestErrorResponseCode

        public String getRequestedTestErrorResponseCode()
        Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.
        Returns:
        requestedTestErrorResponseCode

      • setRequestedTestErrorResponseCode

        public void setRequestedTestErrorResponseCode​(String requestedTestErrorResponseCode)
        Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.
        Parameters:
        requestedTestErrorResponseCode -

      • allowPartialAuth

        public AdditionalDataCommon allowPartialAuth​(String allowPartialAuth)
        Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team.
        Parameters:
        allowPartialAuth -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getAllowPartialAuth

        public String getAllowPartialAuth()
        Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team.
        Returns:
        allowPartialAuth

      • setAllowPartialAuth

        public void setAllowPartialAuth​(String allowPartialAuth)
        Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team.
        Parameters:
        allowPartialAuth -

      • authorisationType

        public AdditionalDataCommon authorisationType​(String authorisationType)
        Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation.
        Parameters:
        authorisationType -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getAuthorisationType

        public String getAuthorisationType()
        Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation.
        Returns:
        authorisationType

      • setAuthorisationType

        public void setAuthorisationType​(String authorisationType)
        Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation.
        Parameters:
        authorisationType -

      • autoRescue

        public AdditionalDataCommon autoRescue​(String autoRescue)
        Set to **true** to enable [Auto Rescue](https://docs.adyen.com/online-payments/auto-rescue/) for a transaction. Use the `maxDaysToRescue` to specify a rescue window.
        Parameters:
        autoRescue -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getAutoRescue

        public String getAutoRescue()
        Set to **true** to enable [Auto Rescue](https://docs.adyen.com/online-payments/auto-rescue/) for a transaction. Use the `maxDaysToRescue` to specify a rescue window.
        Returns:
        autoRescue

      • setAutoRescue

        public void setAutoRescue​(String autoRescue)
        Set to **true** to enable [Auto Rescue](https://docs.adyen.com/online-payments/auto-rescue/) for a transaction. Use the `maxDaysToRescue` to specify a rescue window.
        Parameters:
        autoRescue -

      • customRoutingFlag

        public AdditionalDataCommon customRoutingFlag​(String customRoutingFlag)
        Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).
        Parameters:
        customRoutingFlag -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getCustomRoutingFlag

        public String getCustomRoutingFlag()
        Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).
        Returns:
        customRoutingFlag

      • setCustomRoutingFlag

        public void setCustomRoutingFlag​(String customRoutingFlag)
        Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).
        Parameters:
        customRoutingFlag -

      • industryUsage

        public AdditionalDataCommon industryUsage​(AdditionalDataCommon.IndustryUsageEnum industryUsage)
        In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.
        Parameters:
        industryUsage -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getIndustryUsage

        public AdditionalDataCommon.IndustryUsageEnum getIndustryUsage()
        In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.
        Returns:
        industryUsage

      • setIndustryUsage

        public void setIndustryUsage​(AdditionalDataCommon.IndustryUsageEnum industryUsage)
        In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.
        Parameters:
        industryUsage -

      • manualCapture

        public AdditionalDataCommon manualCapture​(String manualCapture)
        Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.
        Parameters:
        manualCapture -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getManualCapture

        public String getManualCapture()
        Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.
        Returns:
        manualCapture

      • setManualCapture

        public void setManualCapture​(String manualCapture)
        Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.
        Parameters:
        manualCapture -

      • maxDaysToRescue

        public AdditionalDataCommon maxDaysToRescue​(String maxDaysToRescue)
        The rescue window for a transaction, in days, when `autoRescue` is set to **true**. You can specify a value between 1 and 48. * For [cards](https://docs.adyen.com/online-payments/auto-rescue/cards/), the default is one calendar month. * For [SEPA](https://docs.adyen.com/online-payments/auto-rescue/sepa/), the default is 42 days.
        Parameters:
        maxDaysToRescue -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getMaxDaysToRescue

        public String getMaxDaysToRescue()
        The rescue window for a transaction, in days, when `autoRescue` is set to **true**. You can specify a value between 1 and 48. * For [cards](https://docs.adyen.com/online-payments/auto-rescue/cards/), the default is one calendar month. * For [SEPA](https://docs.adyen.com/online-payments/auto-rescue/sepa/), the default is 42 days.
        Returns:
        maxDaysToRescue

      • setMaxDaysToRescue

        public void setMaxDaysToRescue​(String maxDaysToRescue)
        The rescue window for a transaction, in days, when `autoRescue` is set to **true**. You can specify a value between 1 and 48. * For [cards](https://docs.adyen.com/online-payments/auto-rescue/cards/), the default is one calendar month. * For [SEPA](https://docs.adyen.com/online-payments/auto-rescue/sepa/), the default is 42 days.
        Parameters:
        maxDaysToRescue -

      • networkTxReference

        public AdditionalDataCommon networkTxReference​(String networkTxReference)
        Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.
        Parameters:
        networkTxReference -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getNetworkTxReference

        public String getNetworkTxReference()
        Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.
        Returns:
        networkTxReference

      • setNetworkTxReference

        public void setNetworkTxReference​(String networkTxReference)
        Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.
        Parameters:
        networkTxReference -

      • overwriteBrand

        public AdditionalDataCommon overwriteBrand​(String overwriteBrand)
        Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.
        Parameters:
        overwriteBrand -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getOverwriteBrand

        public String getOverwriteBrand()
        Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.
        Returns:
        overwriteBrand

      • setOverwriteBrand

        public void setOverwriteBrand​(String overwriteBrand)
        Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.
        Parameters:
        overwriteBrand -

      • subMerchantCity

        public AdditionalDataCommon subMerchantCity​(String subMerchantCity)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters.
        Parameters:
        subMerchantCity -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantCity

        public String getSubMerchantCity()
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters.
        Returns:
        subMerchantCity

      • setSubMerchantCity

        public void setSubMerchantCity​(String subMerchantCity)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters.
        Parameters:
        subMerchantCity -

      • subMerchantCountry

        public AdditionalDataCommon subMerchantCountry​(String subMerchantCountry)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters.
        Parameters:
        subMerchantCountry -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantCountry

        public String getSubMerchantCountry()
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters.
        Returns:
        subMerchantCountry

      • setSubMerchantCountry

        public void setSubMerchantCountry​(String subMerchantCountry)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters.
        Parameters:
        subMerchantCountry -

      • subMerchantID

        public AdditionalDataCommon subMerchantID​(String subMerchantID)
        This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters.
        Parameters:
        subMerchantID -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantID

        public String getSubMerchantID()
        This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters.
        Returns:
        subMerchantID

      • setSubMerchantID

        public void setSubMerchantID​(String subMerchantID)
        This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters.
        Parameters:
        subMerchantID -

      • subMerchantName

        public AdditionalDataCommon subMerchantName​(String subMerchantName)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters.
        Parameters:
        subMerchantName -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantName

        public String getSubMerchantName()
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters.
        Returns:
        subMerchantName

      • setSubMerchantName

        public void setSubMerchantName​(String subMerchantName)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters.
        Parameters:
        subMerchantName -

      • subMerchantPostalCode

        public AdditionalDataCommon subMerchantPostalCode​(String subMerchantPostalCode)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters.
        Parameters:
        subMerchantPostalCode -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantPostalCode

        public String getSubMerchantPostalCode()
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters.
        Returns:
        subMerchantPostalCode

      • setSubMerchantPostalCode

        public void setSubMerchantPostalCode​(String subMerchantPostalCode)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters.
        Parameters:
        subMerchantPostalCode -

      • subMerchantState

        public AdditionalDataCommon subMerchantState​(String subMerchantState)
        This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters.
        Parameters:
        subMerchantState -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantState

        public String getSubMerchantState()
        This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters.
        Returns:
        subMerchantState

      • setSubMerchantState

        public void setSubMerchantState​(String subMerchantState)
        This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters.
        Parameters:
        subMerchantState -

      • subMerchantStreet

        public AdditionalDataCommon subMerchantStreet​(String subMerchantStreet)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters.
        Parameters:
        subMerchantStreet -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantStreet

        public String getSubMerchantStreet()
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters.
        Returns:
        subMerchantStreet

      • setSubMerchantStreet

        public void setSubMerchantStreet​(String subMerchantStreet)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters.
        Parameters:
        subMerchantStreet -

      • subMerchantTaxId

        public AdditionalDataCommon subMerchantTaxId​(String subMerchantTaxId)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters.
        Parameters:
        subMerchantTaxId -
        Returns:
        the current AdditionalDataCommon instance, allowing for method chaining

      • getSubMerchantTaxId

        public String getSubMerchantTaxId()
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters.
        Returns:
        subMerchantTaxId

      • setSubMerchantTaxId

        public void setSubMerchantTaxId​(String subMerchantTaxId)
        This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters.
        Parameters:
        subMerchantTaxId -

      • equals

        public boolean equals​(Object o)
        Return true if this AdditionalDataCommon object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static AdditionalDataCommon fromJson​(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of AdditionalDataCommon given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of AdditionalDataCommon
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to AdditionalDataCommon

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of AdditionalDataCommon to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException