Package com.adyen.model.recurring

Class RecurringDetail

  • public class RecurringDetail
extends Object
    RecurringDetail

    • Constructor Detail

      • RecurringDetail

        public RecurringDetail()

    • Method Detail

      • additionalData

        public RecurringDetail additionalData​(Map<String,​String> additionalData)
        This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.
        Parameters:
        additionalData - This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getAdditionalData

        public Map<String,​String> getAdditionalData()
        This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.
        Returns:
        additionalData This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.

      • setAdditionalData

        public void setAdditionalData​(Map<String,​String> additionalData)
        This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.
        Parameters:
        additionalData - This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value.

      • alias

        public RecurringDetail alias​(String alias)
        The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Parameters:
        alias - The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getAlias

        public String getAlias()
        The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Returns:
        alias The alias of the credit card number. Applies only to recurring contracts storing credit card details

      • setAlias

        public void setAlias​(String alias)
        The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Parameters:
        alias - The alias of the credit card number. Applies only to recurring contracts storing credit card details

      • aliasType

        public RecurringDetail aliasType​(String aliasType)
        The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Parameters:
        aliasType - The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getAliasType

        public String getAliasType()
        The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Returns:
        aliasType The alias type of the credit card number. Applies only to recurring contracts storing credit card details.

      • setAliasType

        public void setAliasType​(String aliasType)
        The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Parameters:
        aliasType - The alias type of the credit card number. Applies only to recurring contracts storing credit card details.

      • bank

        public RecurringDetail bank​(BankAccount bank)
        bank
        Parameters:
        bank -
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getBank

        public BankAccount getBank()
        Get bank
        Returns:
        bank

      • setBank

        public void setBank​(BankAccount bank)
        bank
        Parameters:
        bank -

      • billingAddress

        public RecurringDetail billingAddress​(Address billingAddress)
        billingAddress
        Parameters:
        billingAddress -
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getBillingAddress

        public Address getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress

      • setBillingAddress

        public void setBillingAddress​(Address billingAddress)
        billingAddress
        Parameters:
        billingAddress -

      • card

        public RecurringDetail card​(Card card)
        card
        Parameters:
        card -
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getCard

        public Card getCard()
        Get card
        Returns:
        card

      • setCard

        public void setCard​(Card card)
        card
        Parameters:
        card -

      • contractTypes

        public RecurringDetail contractTypes​(List<String> contractTypes)
        Types of recurring contracts.
        Parameters:
        contractTypes - Types of recurring contracts.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getContractTypes

        public List<String> getContractTypes()
        Types of recurring contracts.
        Returns:
        contractTypes Types of recurring contracts.

      • setContractTypes

        public void setContractTypes​(List<String> contractTypes)
        Types of recurring contracts.
        Parameters:
        contractTypes - Types of recurring contracts.

      • creationDate

        public RecurringDetail creationDate​(OffsetDateTime creationDate)
        The date when the recurring details were created.
        Parameters:
        creationDate - The date when the recurring details were created.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getCreationDate

        public OffsetDateTime getCreationDate()
        The date when the recurring details were created.
        Returns:
        creationDate The date when the recurring details were created.

      • setCreationDate

        public void setCreationDate​(OffsetDateTime creationDate)
        The date when the recurring details were created.
        Parameters:
        creationDate - The date when the recurring details were created.

      • firstPspReference

        public RecurringDetail firstPspReference​(String firstPspReference)
        The `pspReference` of the first recurring payment that created the recurring detail.
        Parameters:
        firstPspReference - The `pspReference` of the first recurring payment that created the recurring detail.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getFirstPspReference

        public String getFirstPspReference()
        The `pspReference` of the first recurring payment that created the recurring detail.
        Returns:
        firstPspReference The `pspReference` of the first recurring payment that created the recurring detail.

      • setFirstPspReference

        public void setFirstPspReference​(String firstPspReference)
        The `pspReference` of the first recurring payment that created the recurring detail.
        Parameters:
        firstPspReference - The `pspReference` of the first recurring payment that created the recurring detail.

      • name

        public RecurringDetail name​(String name)
        An optional descriptive name for this recurring detail.
        Parameters:
        name - An optional descriptive name for this recurring detail.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getName

        public String getName()
        An optional descriptive name for this recurring detail.
        Returns:
        name An optional descriptive name for this recurring detail.

      • setName

        public void setName​(String name)
        An optional descriptive name for this recurring detail.
        Parameters:
        name - An optional descriptive name for this recurring detail.

      • networkTxReference

        public RecurringDetail networkTxReference​(String networkTxReference)
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Parameters:
        networkTxReference - Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getNetworkTxReference

        public String getNetworkTxReference()
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Returns:
        networkTxReference Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.

      • setNetworkTxReference

        public void setNetworkTxReference​(String networkTxReference)
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Parameters:
        networkTxReference - Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.

      • paymentMethodVariant

        public RecurringDetail paymentMethodVariant​(String paymentMethodVariant)
        The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
        Parameters:
        paymentMethodVariant - The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getPaymentMethodVariant

        public String getPaymentMethodVariant()
        The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
        Returns:
        paymentMethodVariant The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).

      • setPaymentMethodVariant

        public void setPaymentMethodVariant​(String paymentMethodVariant)
        The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
        Parameters:
        paymentMethodVariant - The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).

      • recurringDetailReference

        public RecurringDetail recurringDetailReference​(String recurringDetailReference)
        The reference that uniquely identifies the recurring detail.
        Parameters:
        recurringDetailReference - The reference that uniquely identifies the recurring detail.
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getRecurringDetailReference

        public String getRecurringDetailReference()
        The reference that uniquely identifies the recurring detail.
        Returns:
        recurringDetailReference The reference that uniquely identifies the recurring detail.

      • setRecurringDetailReference

        public void setRecurringDetailReference​(String recurringDetailReference)
        The reference that uniquely identifies the recurring detail.
        Parameters:
        recurringDetailReference - The reference that uniquely identifies the recurring detail.

      • shopperName

        public RecurringDetail shopperName​(Name shopperName)
        shopperName
        Parameters:
        shopperName -
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getShopperName

        public Name getShopperName()
        Get shopperName
        Returns:
        shopperName

      • setShopperName

        public void setShopperName​(Name shopperName)
        shopperName
        Parameters:
        shopperName -

      • socialSecurityNumber

        public RecurringDetail socialSecurityNumber​(String socialSecurityNumber)
        A shopper's social security number (only in countries where it is legal to collect).
        Parameters:
        socialSecurityNumber - A shopper's social security number (only in countries where it is legal to collect).
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getSocialSecurityNumber

        public String getSocialSecurityNumber()
        A shopper's social security number (only in countries where it is legal to collect).
        Returns:
        socialSecurityNumber A shopper's social security number (only in countries where it is legal to collect).

      • setSocialSecurityNumber

        public void setSocialSecurityNumber​(String socialSecurityNumber)
        A shopper's social security number (only in countries where it is legal to collect).
        Parameters:
        socialSecurityNumber - A shopper's social security number (only in countries where it is legal to collect).

      • tokenDetails

        public RecurringDetail tokenDetails​(TokenDetails tokenDetails)
        tokenDetails
        Parameters:
        tokenDetails -
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getTokenDetails

        public TokenDetails getTokenDetails()
        Get tokenDetails
        Returns:
        tokenDetails

      • setTokenDetails

        public void setTokenDetails​(TokenDetails tokenDetails)
        tokenDetails
        Parameters:
        tokenDetails -

      • variant

        public RecurringDetail variant​(String variant)
        The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".
        Parameters:
        variant - The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".
        Returns:
        the current RecurringDetail instance, allowing for method chaining

      • getVariant

        public String getVariant()
        The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".
        Returns:
        variant The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".

      • setVariant

        public void setVariant​(String variant)
        The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".
        Parameters:
        variant - The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".

      • includeNullValues

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

      • toJson

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