Package com.adyen.model.recurring

Class NotifyShopperRequest

  • public class NotifyShopperRequest
extends Object
    NotifyShopperRequest

    • Constructor Detail

      • NotifyShopperRequest

        public NotifyShopperRequest()

    • Method Detail

      • amount

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

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

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

      • billingDate

        public NotifyShopperRequest billingDate​(String billingDate)
        Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
        Parameters:
        billingDate - Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getBillingDate

        public String getBillingDate()
        Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
        Returns:
        billingDate Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format

      • setBillingDate

        public void setBillingDate​(String billingDate)
        Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format
        Parameters:
        billingDate - Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format

      • billingSequenceNumber

        public NotifyShopperRequest billingSequenceNumber​(String billingSequenceNumber)
        Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
        Parameters:
        billingSequenceNumber - Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getBillingSequenceNumber

        public String getBillingSequenceNumber()
        Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
        Returns:
        billingSequenceNumber Sequence of the debit. Depends on Frequency and Billing Attempts Rule.

      • setBillingSequenceNumber

        public void setBillingSequenceNumber​(String billingSequenceNumber)
        Sequence of the debit. Depends on Frequency and Billing Attempts Rule.
        Parameters:
        billingSequenceNumber - Sequence of the debit. Depends on Frequency and Billing Attempts Rule.

      • displayedReference

        public NotifyShopperRequest displayedReference​(String displayedReference)
        Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
        Parameters:
        displayedReference - Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getDisplayedReference

        public String getDisplayedReference()
        Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
        Returns:
        displayedReference Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing

      • setDisplayedReference

        public void setDisplayedReference​(String displayedReference)
        Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing
        Parameters:
        displayedReference - Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing

      • merchantAccount

        public NotifyShopperRequest 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 NotifyShopperRequest 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.

      • recurringDetailReference

        public NotifyShopperRequest recurringDetailReference​(String recurringDetailReference)
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        recurringDetailReference - This is the `recurringDetailReference` returned in the response when you created the token.
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getRecurringDetailReference

        public String getRecurringDetailReference()
        This is the `recurringDetailReference` returned in the response when you created the token.
        Returns:
        recurringDetailReference This is the `recurringDetailReference` returned in the response when you created the token.

      • setRecurringDetailReference

        public void setRecurringDetailReference​(String recurringDetailReference)
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        recurringDetailReference - This is the `recurringDetailReference` returned in the response when you created the token.

      • reference

        public NotifyShopperRequest reference​(String reference)
        Pre-debit notification reference sent by the merchant. This is a mandatory field
        Parameters:
        reference - Pre-debit notification reference sent by the merchant. This is a mandatory field
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getReference

        public String getReference()
        Pre-debit notification reference sent by the merchant. This is a mandatory field
        Returns:
        reference Pre-debit notification reference sent by the merchant. This is a mandatory field

      • setReference

        public void setReference​(String reference)
        Pre-debit notification reference sent by the merchant. This is a mandatory field
        Parameters:
        reference - Pre-debit notification reference sent by the merchant. This is a mandatory field

      • shopperReference

        public NotifyShopperRequest shopperReference​(String shopperReference)
        The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
        Parameters:
        shopperReference - The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getShopperReference

        public String getShopperReference()
        The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
        Returns:
        shopperReference The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.

      • setShopperReference

        public void setShopperReference​(String shopperReference)
        The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.
        Parameters:
        shopperReference - The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment.

      • storedPaymentMethodId

        public NotifyShopperRequest storedPaymentMethodId​(String storedPaymentMethodId)
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        storedPaymentMethodId - This is the `recurringDetailReference` returned in the response when you created the token.
        Returns:
        the current NotifyShopperRequest instance, allowing for method chaining

      • getStoredPaymentMethodId

        public String getStoredPaymentMethodId()
        This is the `recurringDetailReference` returned in the response when you created the token.
        Returns:
        storedPaymentMethodId This is the `recurringDetailReference` returned in the response when you created the token.

      • setStoredPaymentMethodId

        public void setStoredPaymentMethodId​(String storedPaymentMethodId)
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        storedPaymentMethodId - This is the `recurringDetailReference` returned in the response when you created the token.

      • includeNullValues

        public NotifyShopperRequest 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 NotifyShopperRequest 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 NotifyShopperRequest fromJson​(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of NotifyShopperRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of NotifyShopperRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to NotifyShopperRequest

      • toJson

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