Package com.adyen.model.storedvalue

Class StoredValueLoadRequest

  • public class StoredValueLoadRequest
extends Object
    StoredValueLoadRequest

    • Constructor Detail

      • StoredValueLoadRequest

        public StoredValueLoadRequest()

    • Method Detail

      • amount

        public StoredValueLoadRequest amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -

      • loadType

        public StoredValueLoadRequest loadType​(StoredValueLoadRequest.LoadTypeEnum loadType)
        The type of load you are trying to do, when absent we default to 'Load'
        Parameters:
        loadType - The type of load you are trying to do, when absent we default to 'Load'
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getLoadType

        public StoredValueLoadRequest.LoadTypeEnum getLoadType()
        The type of load you are trying to do, when absent we default to 'Load'
        Returns:
        loadType The type of load you are trying to do, when absent we default to 'Load'

      • setLoadType

        public void setLoadType​(StoredValueLoadRequest.LoadTypeEnum loadType)
        The type of load you are trying to do, when absent we default to 'Load'
        Parameters:
        loadType - The type of load you are trying to do, when absent we default to 'Load'

      • merchantAccount

        public StoredValueLoadRequest merchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount - The merchant account identifier, with which you want to process the transaction.
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account identifier, with which you want to process the transaction.
        Returns:
        merchantAccount The merchant account identifier, with which you want to process the transaction.

      • setMerchantAccount

        public void setMerchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount - The merchant account identifier, with which you want to process the transaction.

      • paymentMethod

        public StoredValueLoadRequest paymentMethod​(Map<String,​String> paymentMethod)
        The collection that contains the type of the payment method and its specific information if available
        Parameters:
        paymentMethod - The collection that contains the type of the payment method and its specific information if available
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getPaymentMethod

        public Map<String,​String> getPaymentMethod()
        The collection that contains the type of the payment method and its specific information if available
        Returns:
        paymentMethod The collection that contains the type of the payment method and its specific information if available

      • setPaymentMethod

        public void setPaymentMethod​(Map<String,​String> paymentMethod)
        The collection that contains the type of the payment method and its specific information if available
        Parameters:
        paymentMethod - The collection that contains the type of the payment method and its specific information if available

      • recurringDetailReference

        public StoredValueLoadRequest recurringDetailReference​(String recurringDetailReference)
        recurringDetailReference
        Parameters:
        recurringDetailReference -
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getRecurringDetailReference

        public String getRecurringDetailReference()
        Get recurringDetailReference
        Returns:
        recurringDetailReference

      • setRecurringDetailReference

        public void setRecurringDetailReference​(String recurringDetailReference)
        recurringDetailReference
        Parameters:
        recurringDetailReference -

      • reference

        public StoredValueLoadRequest reference​(String reference)
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Parameters:
        reference - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getReference

        public String getReference()
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Returns:
        reference The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.

      • setReference

        public void setReference​(String reference)
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Parameters:
        reference - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.

      • shopperInteraction

        public StoredValueLoadRequest shopperInteraction​(StoredValueLoadRequest.ShopperInteractionEnum shopperInteraction)
        Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Parameters:
        shopperInteraction - Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getShopperInteraction

        public StoredValueLoadRequest.ShopperInteractionEnum getShopperInteraction()
        Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Returns:
        shopperInteraction Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.

      • setShopperInteraction

        public void setShopperInteraction​(StoredValueLoadRequest.ShopperInteractionEnum shopperInteraction)
        Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Parameters:
        shopperInteraction - Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.

      • shopperReference

        public StoredValueLoadRequest shopperReference​(String shopperReference)
        shopperReference
        Parameters:
        shopperReference -
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getShopperReference

        public String getShopperReference()
        Get shopperReference
        Returns:
        shopperReference

      • setShopperReference

        public void setShopperReference​(String shopperReference)
        shopperReference
        Parameters:
        shopperReference -

      • store

        public StoredValueLoadRequest store​(String store)
        The physical store, for which this payment is processed.
        Parameters:
        store - The physical store, for which this payment is processed.
        Returns:
        the current StoredValueLoadRequest instance, allowing for method chaining

      • getStore

        public String getStore()
        The physical store, for which this payment is processed.
        Returns:
        store The physical store, for which this payment is processed.

      • setStore

        public void setStore​(String store)
        The physical store, for which this payment is processed.
        Parameters:
        store - The physical store, for which this payment is processed.

      • includeNullValues

        public StoredValueLoadRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

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

      • toJson

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