Package com.adyen.model.payment

Class AdditionalDataRisk

  • public class AdditionalDataRisk
extends Object
    AdditionalDataRisk

    • Field Detail

      • JSON_PROPERTY_RISKDATA_CUSTOM_FIELD_NAME

        public static final String JSON_PROPERTY_RISKDATA_CUSTOM_FIELD_NAME
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_AMOUNT_PER_ITEM

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_AMOUNT_PER_ITEM
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_BRAND

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_BRAND
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CATEGORY

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CATEGORY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_COLOR

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_COLOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CURRENCY

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CURRENCY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_ITEM_I_D

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_ITEM_I_D
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_MANUFACTURER

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_MANUFACTURER
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_PRODUCT_TITLE

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_PRODUCT_TITLE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_QUANTITY

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_QUANTITY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_RECEIVER_EMAIL

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_RECEIVER_EMAIL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SIZE

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SIZE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SKU

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SKU
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_UPC

        public static final String JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_UPC
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_CODE

        public static final String JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_CODE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_AMOUNT

        public static final String JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_AMOUNT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_CURRENCY

        public static final String JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_CURRENCY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_PERCENTAGE

        public static final String JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_PERCENTAGE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_NAME

        public static final String JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_NAME
        See Also:
        Constant Field Values

      • JSON_PROPERTY_RISKDATA_RISK_PROFILE_REFERENCE

        public static final String JSON_PROPERTY_RISKDATA_RISK_PROFILE_REFERENCE
        See Also:
        Constant Field Values

    • Constructor Detail

      • AdditionalDataRisk

        public AdditionalDataRisk()

    • Method Detail

      • getRiskdataCustomFieldName

        public String getRiskdataCustomFieldName()
        The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).
        Returns:
        riskdataCustomFieldName

      • setRiskdataCustomFieldName

        public void setRiskdataCustomFieldName​(String riskdataCustomFieldName)
        The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).
        Parameters:
        riskdataCustomFieldName -

      • riskdataBasketItemItemNrAmountPerItem

        public AdditionalDataRisk riskdataBasketItemItemNrAmountPerItem​(String riskdataBasketItemItemNrAmountPerItem)

      • getRiskdataBasketItemItemNrAmountPerItem

        public String getRiskdataBasketItemItemNrAmountPerItem()
        The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
        Returns:
        riskdataBasketItemItemNrAmountPerItem

      • setRiskdataBasketItemItemNrAmountPerItem

        public void setRiskdataBasketItemItemNrAmountPerItem​(String riskdataBasketItemItemNrAmountPerItem)
        The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        riskdataBasketItemItemNrAmountPerItem -

      • riskdataBasketItemItemNrBrand

        public AdditionalDataRisk riskdataBasketItemItemNrBrand​(String riskdataBasketItemItemNrBrand)

      • getRiskdataBasketItemItemNrBrand

        public String getRiskdataBasketItemItemNrBrand()
        Brand of the item.
        Returns:
        riskdataBasketItemItemNrBrand

      • setRiskdataBasketItemItemNrBrand

        public void setRiskdataBasketItemItemNrBrand​(String riskdataBasketItemItemNrBrand)
        Brand of the item.
        Parameters:
        riskdataBasketItemItemNrBrand -

      • riskdataBasketItemItemNrCategory

        public AdditionalDataRisk riskdataBasketItemItemNrCategory​(String riskdataBasketItemItemNrCategory)

      • getRiskdataBasketItemItemNrCategory

        public String getRiskdataBasketItemItemNrCategory()
        Category of the item.
        Returns:
        riskdataBasketItemItemNrCategory

      • setRiskdataBasketItemItemNrCategory

        public void setRiskdataBasketItemItemNrCategory​(String riskdataBasketItemItemNrCategory)
        Category of the item.
        Parameters:
        riskdataBasketItemItemNrCategory -

      • riskdataBasketItemItemNrColor

        public AdditionalDataRisk riskdataBasketItemItemNrColor​(String riskdataBasketItemItemNrColor)

      • getRiskdataBasketItemItemNrColor

        public String getRiskdataBasketItemItemNrColor()
        Color of the item.
        Returns:
        riskdataBasketItemItemNrColor

      • setRiskdataBasketItemItemNrColor

        public void setRiskdataBasketItemItemNrColor​(String riskdataBasketItemItemNrColor)
        Color of the item.
        Parameters:
        riskdataBasketItemItemNrColor -

      • riskdataBasketItemItemNrCurrency

        public AdditionalDataRisk riskdataBasketItemItemNrCurrency​(String riskdataBasketItemItemNrCurrency)

      • getRiskdataBasketItemItemNrCurrency

        public String getRiskdataBasketItemItemNrCurrency()
        The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
        Returns:
        riskdataBasketItemItemNrCurrency

      • setRiskdataBasketItemItemNrCurrency

        public void setRiskdataBasketItemItemNrCurrency​(String riskdataBasketItemItemNrCurrency)
        The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
        Parameters:
        riskdataBasketItemItemNrCurrency -

      • riskdataBasketItemItemNrItemID

        public AdditionalDataRisk riskdataBasketItemItemNrItemID​(String riskdataBasketItemItemNrItemID)

      • getRiskdataBasketItemItemNrItemID

        public String getRiskdataBasketItemItemNrItemID()
        ID of the item.
        Returns:
        riskdataBasketItemItemNrItemID

      • setRiskdataBasketItemItemNrItemID

        public void setRiskdataBasketItemItemNrItemID​(String riskdataBasketItemItemNrItemID)
        ID of the item.
        Parameters:
        riskdataBasketItemItemNrItemID -

      • riskdataBasketItemItemNrManufacturer

        public AdditionalDataRisk riskdataBasketItemItemNrManufacturer​(String riskdataBasketItemItemNrManufacturer)

      • getRiskdataBasketItemItemNrManufacturer

        public String getRiskdataBasketItemItemNrManufacturer()
        Manufacturer of the item.
        Returns:
        riskdataBasketItemItemNrManufacturer

      • setRiskdataBasketItemItemNrManufacturer

        public void setRiskdataBasketItemItemNrManufacturer​(String riskdataBasketItemItemNrManufacturer)
        Manufacturer of the item.
        Parameters:
        riskdataBasketItemItemNrManufacturer -

      • riskdataBasketItemItemNrProductTitle

        public AdditionalDataRisk riskdataBasketItemItemNrProductTitle​(String riskdataBasketItemItemNrProductTitle)

      • getRiskdataBasketItemItemNrProductTitle

        public String getRiskdataBasketItemItemNrProductTitle()
        A text description of the product the invoice line refers to.
        Returns:
        riskdataBasketItemItemNrProductTitle

      • setRiskdataBasketItemItemNrProductTitle

        public void setRiskdataBasketItemItemNrProductTitle​(String riskdataBasketItemItemNrProductTitle)
        A text description of the product the invoice line refers to.
        Parameters:
        riskdataBasketItemItemNrProductTitle -

      • riskdataBasketItemItemNrQuantity

        public AdditionalDataRisk riskdataBasketItemItemNrQuantity​(String riskdataBasketItemItemNrQuantity)

      • getRiskdataBasketItemItemNrQuantity

        public String getRiskdataBasketItemItemNrQuantity()
        Quantity of the item purchased.
        Returns:
        riskdataBasketItemItemNrQuantity

      • setRiskdataBasketItemItemNrQuantity

        public void setRiskdataBasketItemItemNrQuantity​(String riskdataBasketItemItemNrQuantity)
        Quantity of the item purchased.
        Parameters:
        riskdataBasketItemItemNrQuantity -

      • riskdataBasketItemItemNrReceiverEmail

        public AdditionalDataRisk riskdataBasketItemItemNrReceiverEmail​(String riskdataBasketItemItemNrReceiverEmail)

      • getRiskdataBasketItemItemNrReceiverEmail

        public String getRiskdataBasketItemItemNrReceiverEmail()
        Email associated with the given product in the basket (usually in electronic gift cards).
        Returns:
        riskdataBasketItemItemNrReceiverEmail

      • setRiskdataBasketItemItemNrReceiverEmail

        public void setRiskdataBasketItemItemNrReceiverEmail​(String riskdataBasketItemItemNrReceiverEmail)
        Email associated with the given product in the basket (usually in electronic gift cards).
        Parameters:
        riskdataBasketItemItemNrReceiverEmail -

      • riskdataBasketItemItemNrSize

        public AdditionalDataRisk riskdataBasketItemItemNrSize​(String riskdataBasketItemItemNrSize)

      • getRiskdataBasketItemItemNrSize

        public String getRiskdataBasketItemItemNrSize()
        Size of the item.
        Returns:
        riskdataBasketItemItemNrSize

      • setRiskdataBasketItemItemNrSize

        public void setRiskdataBasketItemItemNrSize​(String riskdataBasketItemItemNrSize)
        Size of the item.
        Parameters:
        riskdataBasketItemItemNrSize -

      • riskdataBasketItemItemNrSku

        public AdditionalDataRisk riskdataBasketItemItemNrSku​(String riskdataBasketItemItemNrSku)

      • getRiskdataBasketItemItemNrSku

        public String getRiskdataBasketItemItemNrSku()
        [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).
        Returns:
        riskdataBasketItemItemNrSku

      • setRiskdataBasketItemItemNrSku

        public void setRiskdataBasketItemItemNrSku​(String riskdataBasketItemItemNrSku)
        [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).
        Parameters:
        riskdataBasketItemItemNrSku -

      • riskdataBasketItemItemNrUpc

        public AdditionalDataRisk riskdataBasketItemItemNrUpc​(String riskdataBasketItemItemNrUpc)

      • getRiskdataBasketItemItemNrUpc

        public String getRiskdataBasketItemItemNrUpc()
        [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).
        Returns:
        riskdataBasketItemItemNrUpc

      • setRiskdataBasketItemItemNrUpc

        public void setRiskdataBasketItemItemNrUpc​(String riskdataBasketItemItemNrUpc)
        [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).
        Parameters:
        riskdataBasketItemItemNrUpc -

      • riskdataPromotionsPromotionItemNrPromotionCode

        public AdditionalDataRisk riskdataPromotionsPromotionItemNrPromotionCode​(String riskdataPromotionsPromotionItemNrPromotionCode)

      • getRiskdataPromotionsPromotionItemNrPromotionCode

        public String getRiskdataPromotionsPromotionItemNrPromotionCode()
        Code of the promotion.
        Returns:
        riskdataPromotionsPromotionItemNrPromotionCode

      • setRiskdataPromotionsPromotionItemNrPromotionCode

        public void setRiskdataPromotionsPromotionItemNrPromotionCode​(String riskdataPromotionsPromotionItemNrPromotionCode)
        Code of the promotion.
        Parameters:
        riskdataPromotionsPromotionItemNrPromotionCode -

      • riskdataPromotionsPromotionItemNrPromotionDiscountAmount

        public AdditionalDataRisk riskdataPromotionsPromotionItemNrPromotionDiscountAmount​(String riskdataPromotionsPromotionItemNrPromotionDiscountAmount)

      • getRiskdataPromotionsPromotionItemNrPromotionDiscountAmount

        public String getRiskdataPromotionsPromotionItemNrPromotionDiscountAmount()
        The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
        Returns:
        riskdataPromotionsPromotionItemNrPromotionDiscountAmount

      • setRiskdataPromotionsPromotionItemNrPromotionDiscountAmount

        public void setRiskdataPromotionsPromotionItemNrPromotionDiscountAmount​(String riskdataPromotionsPromotionItemNrPromotionDiscountAmount)
        The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        riskdataPromotionsPromotionItemNrPromotionDiscountAmount -

      • riskdataPromotionsPromotionItemNrPromotionDiscountCurrency

        public AdditionalDataRisk riskdataPromotionsPromotionItemNrPromotionDiscountCurrency​(String riskdataPromotionsPromotionItemNrPromotionDiscountCurrency)

      • getRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency

        public String getRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency()
        The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
        Returns:
        riskdataPromotionsPromotionItemNrPromotionDiscountCurrency

      • setRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency

        public void setRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency​(String riskdataPromotionsPromotionItemNrPromotionDiscountCurrency)
        The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
        Parameters:
        riskdataPromotionsPromotionItemNrPromotionDiscountCurrency -

      • riskdataPromotionsPromotionItemNrPromotionDiscountPercentage

        public AdditionalDataRisk riskdataPromotionsPromotionItemNrPromotionDiscountPercentage​(String riskdataPromotionsPromotionItemNrPromotionDiscountPercentage)

      • getRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage

        public String getRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage()
        Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. e.g. for a promotion discount of 30%, the value of the field should be 30.
        Returns:
        riskdataPromotionsPromotionItemNrPromotionDiscountPercentage

      • setRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage

        public void setRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage​(String riskdataPromotionsPromotionItemNrPromotionDiscountPercentage)
        Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. e.g. for a promotion discount of 30%, the value of the field should be 30.
        Parameters:
        riskdataPromotionsPromotionItemNrPromotionDiscountPercentage -

      • riskdataPromotionsPromotionItemNrPromotionName

        public AdditionalDataRisk riskdataPromotionsPromotionItemNrPromotionName​(String riskdataPromotionsPromotionItemNrPromotionName)

      • getRiskdataPromotionsPromotionItemNrPromotionName

        public String getRiskdataPromotionsPromotionItemNrPromotionName()
        Name of the promotion.
        Returns:
        riskdataPromotionsPromotionItemNrPromotionName

      • setRiskdataPromotionsPromotionItemNrPromotionName

        public void setRiskdataPromotionsPromotionItemNrPromotionName​(String riskdataPromotionsPromotionItemNrPromotionName)
        Name of the promotion.
        Parameters:
        riskdataPromotionsPromotionItemNrPromotionName -

      • riskdataRiskProfileReference

        public AdditionalDataRisk riskdataRiskProfileReference​(String riskdataRiskProfileReference)

      • getRiskdataRiskProfileReference

        public String getRiskdataRiskProfileReference()
        Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).
        Returns:
        riskdataRiskProfileReference

      • setRiskdataRiskProfileReference

        public void setRiskdataRiskProfileReference​(String riskdataRiskProfileReference)
        Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).
        Parameters:
        riskdataRiskProfileReference -

      • getRiskdataSkipRisk

        public String getRiskdataSkipRisk()
        If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.
        Returns:
        riskdataSkipRisk

      • setRiskdataSkipRisk

        public void setRiskdataSkipRisk​(String riskdataSkipRisk)
        If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.
        Parameters:
        riskdataSkipRisk -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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