Mandate (Adyen Java API Library 17.3.0 API)

java.lang.Object
- com.adyen.model.checkout.Mandate

```
public class Mandate
extends Object
```
Mandate

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Mandate.AmountRuleEnum` The limitation rule of the billing amount.
`static class`	`Mandate.BillingAttemptsRuleEnum` The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.
`static class`	`Mandate.FrequencyEnum` The frequency with which a shopper should be charged.

Constructor Summary

Constructors
Constructor and Description

Mandate()

Constructors
Constructor and Description
`Mandate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mandate`	`amount(String amount)`
`Mandate`	`amountRule(Mandate.AmountRuleEnum amountRule)`
`Mandate`	`billingAttemptsRule(Mandate.BillingAttemptsRuleEnum billingAttemptsRule)`
`Mandate`	`billingDay(String billingDay)`
`Mandate`	`endsAt(String endsAt)`
`boolean`	`equals(Object o)`
`Mandate`	`frequency(Mandate.FrequencyEnum frequency)`
`String`	`getAmount()` The billing amount of the recurring transactions.
`Mandate.AmountRuleEnum`	`getAmountRule()` The limitation rule of the billing amount.
`Mandate.BillingAttemptsRuleEnum`	`getBillingAttemptsRule()` The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.
`String`	`getBillingDay()` The number of the day, on which the recurring debit can happen.
`String`	`getEndsAt()` End date of the billing plan, in YYYY-MM-DD format.
`Mandate.FrequencyEnum`	`getFrequency()` The frequency with which a shopper should be charged.
`String`	`getRemarks()` The message shown by UPI to the shopper on the approval screen.
`String`	`getStartsAt()` Start date of the billing plan, in YYYY-MM-DD format.
`int`	`hashCode()`
`Mandate`	`remarks(String remarks)`
`void`	`setAmount(String amount)`
`void`	`setAmountRule(Mandate.AmountRuleEnum amountRule)`
`void`	`setBillingAttemptsRule(Mandate.BillingAttemptsRuleEnum billingAttemptsRule)`
`void`	`setBillingDay(String billingDay)`
`void`	`setEndsAt(String endsAt)`
`void`	`setFrequency(Mandate.FrequencyEnum frequency)`
`void`	`setRemarks(String remarks)`
`void`	`setStartsAt(String startsAt)`
`Mandate`	`startsAt(String startsAt)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Mandate
```
public Mandate()
```
- Method Detail
  - amount
```
public Mandate amount(String amount)
```
  - getAmount
```
public String getAmount()
```
    The billing amount of the recurring transactions.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(String amount)
```
  - amountRule
```
public Mandate amountRule(Mandate.AmountRuleEnum amountRule)
```
  - getAmountRule
```
public Mandate.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
  - setAmountRule
```
public void setAmountRule(Mandate.AmountRuleEnum amountRule)
```
  - billingAttemptsRule
```
public Mandate billingAttemptsRule(Mandate.BillingAttemptsRuleEnum billingAttemptsRule)
```
  - getBillingAttemptsRule
```
public Mandate.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
  - setBillingAttemptsRule
```
public void setBillingAttemptsRule(Mandate.BillingAttemptsRuleEnum billingAttemptsRule)
```
  - billingDay
```
public Mandate billingDay(String billingDay)
```
  - 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
  - setBillingDay
```
public void setBillingDay(String billingDay)
```
  - endsAt
```
public Mandate endsAt(String endsAt)
```
  - getEndsAt
```
public String getEndsAt()
```
    End date of the billing plan, in YYYY-MM-DD format.
    
    Returns:
    
    endsAt
  - setEndsAt
```
public void setEndsAt(String endsAt)
```
  - frequency
```
public Mandate frequency(Mandate.FrequencyEnum frequency)
```
  - getFrequency
```
public Mandate.FrequencyEnum getFrequency()
```
    The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
    
    Returns:
    
    frequency
  - setFrequency
```
public void setFrequency(Mandate.FrequencyEnum frequency)
```
  - remarks
```
public Mandate remarks(String remarks)
```
  - getRemarks
```
public String getRemarks()
```
    The message shown by UPI to the shopper on the approval screen.
    
    Returns:
    
    remarks
  - setRemarks
```
public void setRemarks(String remarks)
```
  - startsAt
```
public Mandate startsAt(String startsAt)
```
  - getStartsAt
```
public String getStartsAt()
```
    Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
    
    Returns:
    
    startsAt
  - setStartsAt
```
public void setStartsAt(String startsAt)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Mandate

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Mandate

Method Detail

amount

getAmount

setAmount

amountRule

getAmountRule

setAmountRule

billingAttemptsRule

getBillingAttemptsRule

setBillingAttemptsRule

billingDay

getBillingDay

setBillingDay

endsAt

getEndsAt

setEndsAt

frequency

getFrequency

setFrequency

remarks

getRemarks

setRemarks

startsAt

getStartsAt

setStartsAt

equals

hashCode

toString