Package com.adyen.model.checkout

Class TokenMandate

  • public class TokenMandate
extends Object
    TokenMandate

    • Constructor Detail

      • TokenMandate

        public TokenMandate()

    • Method Detail

      • accountIdType

        public TokenMandate accountIdType​(String accountIdType)
        The type of account identifier for the masked account number.
        Parameters:
        accountIdType - The type of account identifier for the masked account number.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getAccountIdType

        public String getAccountIdType()
        The type of account identifier for the masked account number.
        Returns:
        accountIdType The type of account identifier for the masked account number.

      • setAccountIdType

        public void setAccountIdType​(String accountIdType)
        The type of account identifier for the masked account number.
        Parameters:
        accountIdType - The type of account identifier for the masked account number.

      • amount

        public TokenMandate amount​(String amount)
        The billing amount (in minor units) of the recurring transactions.
        Parameters:
        amount - The billing amount (in minor units) of the recurring transactions.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getAmount

        public String getAmount()
        The billing amount (in minor units) of the recurring transactions.
        Returns:
        amount The billing amount (in minor units) of the recurring transactions.

      • setAmount

        public void setAmount​(String amount)
        The billing amount (in minor units) of the recurring transactions.
        Parameters:
        amount - The billing amount (in minor units) of the recurring transactions.

      • amountRule

        public TokenMandate amountRule​(TokenMandate.AmountRuleEnum amountRule)
        The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.
        Parameters:
        amountRule - The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getAmountRule

        public TokenMandate.AmountRuleEnum getAmountRule()
        The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.
        Returns:
        amountRule The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.

      • setAmountRule

        public void setAmountRule​(TokenMandate.AmountRuleEnum amountRule)
        The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.
        Parameters:
        amountRule - The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.

      • billingAttemptsRule

        public TokenMandate billingAttemptsRule​(TokenMandate.BillingAttemptsRuleEnum billingAttemptsRule)
        The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.
        Parameters:
        billingAttemptsRule - The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getBillingAttemptsRule

        public TokenMandate.BillingAttemptsRuleEnum getBillingAttemptsRule()
        The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.
        Returns:
        billingAttemptsRule The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.

      • setBillingAttemptsRule

        public void setBillingAttemptsRule​(TokenMandate.BillingAttemptsRuleEnum billingAttemptsRule)
        The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.
        Parameters:
        billingAttemptsRule - The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.

      • billingDay

        public TokenMandate billingDay​(String billingDay)
        The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.
        Parameters:
        billingDay - The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getBillingDay

        public String getBillingDay()
        The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.
        Returns:
        billingDay The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.

      • setBillingDay

        public void setBillingDay​(String billingDay)
        The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.
        Parameters:
        billingDay - The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.

      • count

        public TokenMandate count​(String count)
        The number of transactions that can be performed within the given frequency.
        Parameters:
        count - The number of transactions that can be performed within the given frequency.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getCount

        public String getCount()
        The number of transactions that can be performed within the given frequency.
        Returns:
        count The number of transactions that can be performed within the given frequency.

      • setCount

        public void setCount​(String count)
        The number of transactions that can be performed within the given frequency.
        Parameters:
        count - The number of transactions that can be performed within the given frequency.

      • currency

        public TokenMandate currency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        currency - The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getCurrency

        public String getCurrency()
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Returns:
        currency The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).

      • setCurrency

        public void setCurrency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        currency - The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).

      • endsAt

        public TokenMandate endsAt​(String endsAt)
        End date of the billing plan, in YYYY-MM-DD format.
        Parameters:
        endsAt - End date of the billing plan, in YYYY-MM-DD format.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getEndsAt

        public String getEndsAt()
        End date of the billing plan, in YYYY-MM-DD format.
        Returns:
        endsAt End date of the billing plan, in YYYY-MM-DD format.

      • setEndsAt

        public void setEndsAt​(String endsAt)
        End date of the billing plan, in YYYY-MM-DD format.
        Parameters:
        endsAt - End date of the billing plan, in YYYY-MM-DD format.

      • frequency

        public TokenMandate frequency​(TokenMandate.FrequencyEnum frequency)
        The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
        Parameters:
        frequency - The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getFrequency

        public TokenMandate.FrequencyEnum getFrequency()
        The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
        Returns:
        frequency The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.

      • setFrequency

        public void setFrequency​(TokenMandate.FrequencyEnum frequency)
        The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
        Parameters:
        frequency - The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.

      • mandateId

        public TokenMandate mandateId​(String mandateId)
        The unique identifier of the mandate.
        Parameters:
        mandateId - The unique identifier of the mandate.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getMandateId

        public String getMandateId()
        The unique identifier of the mandate.
        Returns:
        mandateId The unique identifier of the mandate.

      • setMandateId

        public void setMandateId​(String mandateId)
        The unique identifier of the mandate.
        Parameters:
        mandateId - The unique identifier of the mandate.

      • maskedAccountId

        public TokenMandate maskedAccountId​(String maskedAccountId)
        The masked account number associated with the mandate.
        Parameters:
        maskedAccountId - The masked account number associated with the mandate.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getMaskedAccountId

        public String getMaskedAccountId()
        The masked account number associated with the mandate.
        Returns:
        maskedAccountId The masked account number associated with the mandate.

      • setMaskedAccountId

        public void setMaskedAccountId​(String maskedAccountId)
        The masked account number associated with the mandate.
        Parameters:
        maskedAccountId - The masked account number associated with the mandate.

      • providerId

        public TokenMandate providerId​(String providerId)
        The provider-specific identifier for this mandate.
        Parameters:
        providerId - The provider-specific identifier for this mandate.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getProviderId

        public String getProviderId()
        The provider-specific identifier for this mandate.
        Returns:
        providerId The provider-specific identifier for this mandate.

      • setProviderId

        public void setProviderId​(String providerId)
        The provider-specific identifier for this mandate.
        Parameters:
        providerId - The provider-specific identifier for this mandate.

      • remarks

        public TokenMandate remarks​(String remarks)
        Additional remarks or notes about the mandate.
        Parameters:
        remarks - Additional remarks or notes about the mandate.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getRemarks

        public String getRemarks()
        Additional remarks or notes about the mandate.
        Returns:
        remarks Additional remarks or notes about the mandate.

      • setRemarks

        public void setRemarks​(String remarks)
        Additional remarks or notes about the mandate.
        Parameters:
        remarks - Additional remarks or notes about the mandate.

      • startsAt

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

      • getStartsAt

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

      • setStartsAt

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

      • status

        public TokenMandate status​(String status)
        The status of the mandate. Examples : active, revoked, completed, expired
        Parameters:
        status - The status of the mandate. Examples : active, revoked, completed, expired
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getStatus

        public String getStatus()
        The status of the mandate. Examples : active, revoked, completed, expired
        Returns:
        status The status of the mandate. Examples : active, revoked, completed, expired

      • setStatus

        public void setStatus​(String status)
        The status of the mandate. Examples : active, revoked, completed, expired
        Parameters:
        status - The status of the mandate. Examples : active, revoked, completed, expired

      • txVariant

        public TokenMandate txVariant​(String txVariant)
        The transaction variant used for this mandate.
        Parameters:
        txVariant - The transaction variant used for this mandate.
        Returns:
        the current TokenMandate instance, allowing for method chaining

      • getTxVariant

        public String getTxVariant()
        The transaction variant used for this mandate.
        Returns:
        txVariant The transaction variant used for this mandate.

      • setTxVariant

        public void setTxVariant​(String txVariant)
        The transaction variant used for this mandate.
        Parameters:
        txVariant - The transaction variant used for this mandate.

      • includeNullValues

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

      • toJson

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