Package com.adyen.model.checkout

Class PixRecurring

  • public class PixRecurring
extends Object
    PixRecurring

    • Constructor Detail

      • PixRecurring

        public PixRecurring()

    • Method Detail

      • billingDate

        public PixRecurring billingDate​(String billingDate)
        The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.
        Parameters:
        billingDate - The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getBillingDate

        public String getBillingDate()
        The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.
        Returns:
        billingDate The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.

      • setBillingDate

        public void setBillingDate​(String billingDate)
        The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.
        Parameters:
        billingDate - The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.

      • businessDayOnly

        public PixRecurring businessDayOnly​(Boolean businessDayOnly)
        Flag used to define whether liquidation can happen only on business days
        Parameters:
        businessDayOnly - Flag used to define whether liquidation can happen only on business days
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getBusinessDayOnly

        public Boolean getBusinessDayOnly()
        Flag used to define whether liquidation can happen only on business days
        Returns:
        businessDayOnly Flag used to define whether liquidation can happen only on business days

      • setBusinessDayOnly

        public void setBusinessDayOnly​(Boolean businessDayOnly)
        Flag used to define whether liquidation can happen only on business days
        Parameters:
        businessDayOnly - Flag used to define whether liquidation can happen only on business days

      • endsAt

        public PixRecurring endsAt​(String endsAt)
        End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.
        Parameters:
        endsAt - End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getEndsAt

        public String getEndsAt()
        End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.
        Returns:
        endsAt End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.

      • setEndsAt

        public void setEndsAt​(String endsAt)
        End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.
        Parameters:
        endsAt - End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.

      • frequency

        public PixRecurring frequency​(PixRecurring.FrequencyEnum frequency)
        The frequency at which the shopper will be charged.
        Parameters:
        frequency - The frequency at which the shopper will be charged.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getFrequency

        public PixRecurring.FrequencyEnum getFrequency()
        The frequency at which the shopper will be charged.
        Returns:
        frequency The frequency at which the shopper will be charged.

      • setFrequency

        public void setFrequency​(PixRecurring.FrequencyEnum frequency)
        The frequency at which the shopper will be charged.
        Parameters:
        frequency - The frequency at which the shopper will be charged.

      • minAmount

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

      • getMinAmount

        public Amount getMinAmount()
        Get minAmount
        Returns:
        minAmount

      • setMinAmount

        public void setMinAmount​(Amount minAmount)
        minAmount
        Parameters:
        minAmount -

      • originalPspReference

        public PixRecurring originalPspReference​(String originalPspReference)
        The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.
        Parameters:
        originalPspReference - The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getOriginalPspReference

        public String getOriginalPspReference()
        The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.
        Returns:
        originalPspReference The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.

      • setOriginalPspReference

        public void setOriginalPspReference​(String originalPspReference)
        The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.
        Parameters:
        originalPspReference - The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.

      • recurringAmount

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

      • getRecurringAmount

        public Amount getRecurringAmount()
        Get recurringAmount
        Returns:
        recurringAmount

      • setRecurringAmount

        public void setRecurringAmount​(Amount recurringAmount)
        recurringAmount
        Parameters:
        recurringAmount -

      • recurringStatement

        public PixRecurring recurringStatement​(String recurringStatement)
        The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
        Parameters:
        recurringStatement - The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getRecurringStatement

        public String getRecurringStatement()
        The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
        Returns:
        recurringStatement The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.

      • setRecurringStatement

        public void setRecurringStatement​(String recurringStatement)
        The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
        Parameters:
        recurringStatement - The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.

      • retryPolicy

        public PixRecurring retryPolicy​(Boolean retryPolicy)
        When set to true, you can retry for failed recurring payments. The default value is true.
        Parameters:
        retryPolicy - When set to true, you can retry for failed recurring payments. The default value is true.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getRetryPolicy

        public Boolean getRetryPolicy()
        When set to true, you can retry for failed recurring payments. The default value is true.
        Returns:
        retryPolicy When set to true, you can retry for failed recurring payments. The default value is true.

      • setRetryPolicy

        public void setRetryPolicy​(Boolean retryPolicy)
        When set to true, you can retry for failed recurring payments. The default value is true.
        Parameters:
        retryPolicy - When set to true, you can retry for failed recurring payments. The default value is true.

      • startsAt

        public PixRecurring startsAt​(String startsAt)
        Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.
        Parameters:
        startsAt - Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.
        Returns:
        the current PixRecurring instance, allowing for method chaining

      • getStartsAt

        public String getStartsAt()
        Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.
        Returns:
        startsAt Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.

      • setStartsAt

        public void setStartsAt​(String startsAt)
        Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.
        Parameters:
        startsAt - Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.

      • includeNullValues

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

      • toJson

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