com.adyen.model.payment.Mandate Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
/*
* Adyen Payment API
*
* The version of the OpenAPI document: 68
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.adyen.model.payment;
import java.util.Objects;
import java.util.Map;
import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
/**
* Mandate
*/
@JsonPropertyOrder({
Mandate.JSON_PROPERTY_AMOUNT,
Mandate.JSON_PROPERTY_AMOUNT_RULE,
Mandate.JSON_PROPERTY_BILLING_ATTEMPTS_RULE,
Mandate.JSON_PROPERTY_BILLING_DAY,
Mandate.JSON_PROPERTY_COUNT,
Mandate.JSON_PROPERTY_ENDS_AT,
Mandate.JSON_PROPERTY_FREQUENCY,
Mandate.JSON_PROPERTY_REMARKS,
Mandate.JSON_PROPERTY_STARTS_AT
})
public class Mandate {
public static final String JSON_PROPERTY_AMOUNT = "amount";
private String amount;
/**
* 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`.
*/
public enum AmountRuleEnum {
MAX(String.valueOf("max")),
EXACT(String.valueOf("exact"));
private String value;
AmountRuleEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static AmountRuleEnum fromValue(String value) {
for (AmountRuleEnum b : AmountRuleEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_AMOUNT_RULE = "amountRule";
private AmountRuleEnum amountRule;
/**
* 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.
*/
public enum BillingAttemptsRuleEnum {
ON(String.valueOf("on")),
BEFORE(String.valueOf("before")),
AFTER(String.valueOf("after"));
private String value;
BillingAttemptsRuleEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static BillingAttemptsRuleEnum fromValue(String value) {
for (BillingAttemptsRuleEnum b : BillingAttemptsRuleEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_BILLING_ATTEMPTS_RULE = "billingAttemptsRule";
private BillingAttemptsRuleEnum billingAttemptsRule;
public static final String JSON_PROPERTY_BILLING_DAY = "billingDay";
private String billingDay;
public static final String JSON_PROPERTY_COUNT = "count";
private String count;
public static final String JSON_PROPERTY_ENDS_AT = "endsAt";
private String endsAt;
/**
* The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
*/
public enum FrequencyEnum {
ADHOC(String.valueOf("adhoc")),
DAILY(String.valueOf("daily")),
WEEKLY(String.valueOf("weekly")),
BIWEEKLY(String.valueOf("biWeekly")),
MONTHLY(String.valueOf("monthly")),
QUARTERLY(String.valueOf("quarterly")),
HALFYEARLY(String.valueOf("halfYearly")),
YEARLY(String.valueOf("yearly"));
private String value;
FrequencyEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static FrequencyEnum fromValue(String value) {
for (FrequencyEnum b : FrequencyEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_FREQUENCY = "frequency";
private FrequencyEnum frequency;
public static final String JSON_PROPERTY_REMARKS = "remarks";
private String remarks;
public static final String JSON_PROPERTY_STARTS_AT = "startsAt";
private String startsAt;
public Mandate() {
}
/**
* The billing amount (in minor units) of the recurring transactions.
*
* @param amount The billing amount (in minor units) of the recurring transactions.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate amount(String amount) {
this.amount = amount;
return this;
}
/**
* The billing amount (in minor units) of the recurring transactions.
* @return amount The billing amount (in minor units) of the recurring transactions.
*/
@JsonProperty(JSON_PROPERTY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAmount() {
return amount;
}
/**
* The billing amount (in minor units) of the recurring transactions.
*
* @param amount The billing amount (in minor units) of the recurring transactions.
*/
@JsonProperty(JSON_PROPERTY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAmount(String amount) {
this.amount = amount;
}
/**
* 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`.
*
* @param 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`.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate amountRule(AmountRuleEnum amountRule) {
this.amountRule = amountRule;
return this;
}
/**
* 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`.
* @return 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`.
*/
@JsonProperty(JSON_PROPERTY_AMOUNT_RULE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AmountRuleEnum getAmountRule() {
return 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`.
*
* @param 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`.
*/
@JsonProperty(JSON_PROPERTY_AMOUNT_RULE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAmountRule(AmountRuleEnum amountRule) {
this.amountRule = amountRule;
}
/**
* 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.
*
* @param 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.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate billingAttemptsRule(BillingAttemptsRuleEnum billingAttemptsRule) {
this.billingAttemptsRule = billingAttemptsRule;
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_BILLING_ATTEMPTS_RULE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public BillingAttemptsRuleEnum getBillingAttemptsRule() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_BILLING_ATTEMPTS_RULE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBillingAttemptsRule(BillingAttemptsRuleEnum billingAttemptsRule) {
this.billingAttemptsRule = billingAttemptsRule;
}
/**
* 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`.
*
* @param 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`.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate billingDay(String billingDay) {
this.billingDay = billingDay;
return this;
}
/**
* 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`.
* @return 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`.
*/
@JsonProperty(JSON_PROPERTY_BILLING_DAY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBillingDay() {
return 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`.
*
* @param 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`.
*/
@JsonProperty(JSON_PROPERTY_BILLING_DAY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBillingDay(String billingDay) {
this.billingDay = billingDay;
}
/**
* The number of transactions that can be performed within the given frequency.
*
* @param count The number of transactions that can be performed within the given frequency.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate count(String count) {
this.count = count;
return this;
}
/**
* The number of transactions that can be performed within the given frequency.
* @return count The number of transactions that can be performed within the given frequency.
*/
@JsonProperty(JSON_PROPERTY_COUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCount() {
return count;
}
/**
* The number of transactions that can be performed within the given frequency.
*
* @param count The number of transactions that can be performed within the given frequency.
*/
@JsonProperty(JSON_PROPERTY_COUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCount(String count) {
this.count = count;
}
/**
* End date of the billing plan, in YYYY-MM-DD format.
*
* @param endsAt End date of the billing plan, in YYYY-MM-DD format.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate endsAt(String endsAt) {
this.endsAt = endsAt;
return this;
}
/**
* End date of the billing plan, in YYYY-MM-DD format.
* @return endsAt End date of the billing plan, in YYYY-MM-DD format.
*/
@JsonProperty(JSON_PROPERTY_ENDS_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEndsAt() {
return endsAt;
}
/**
* End date of the billing plan, in YYYY-MM-DD format.
*
* @param endsAt End date of the billing plan, in YYYY-MM-DD format.
*/
@JsonProperty(JSON_PROPERTY_ENDS_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEndsAt(String endsAt) {
this.endsAt = endsAt;
}
/**
* The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
*
* @param frequency The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate frequency(FrequencyEnum frequency) {
this.frequency = frequency;
return this;
}
/**
* The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
* @return frequency The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
*/
@JsonProperty(JSON_PROPERTY_FREQUENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public FrequencyEnum getFrequency() {
return frequency;
}
/**
* The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
*
* @param frequency The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
*/
@JsonProperty(JSON_PROPERTY_FREQUENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFrequency(FrequencyEnum frequency) {
this.frequency = frequency;
}
/**
* The message shown by UPI to the shopper on the approval screen.
*
* @param remarks The message shown by UPI to the shopper on the approval screen.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate remarks(String remarks) {
this.remarks = remarks;
return this;
}
/**
* The message shown by UPI to the shopper on the approval screen.
* @return remarks The message shown by UPI to the shopper on the approval screen.
*/
@JsonProperty(JSON_PROPERTY_REMARKS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getRemarks() {
return remarks;
}
/**
* The message shown by UPI to the shopper on the approval screen.
*
* @param remarks The message shown by UPI to the shopper on the approval screen.
*/
@JsonProperty(JSON_PROPERTY_REMARKS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setRemarks(String remarks) {
this.remarks = remarks;
}
/**
* Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
*
* @param startsAt Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
* @return the current {@code Mandate} instance, allowing for method chaining
*/
public Mandate startsAt(String startsAt) {
this.startsAt = startsAt;
return this;
}
/**
* Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
* @return startsAt Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
*/
@JsonProperty(JSON_PROPERTY_STARTS_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStartsAt() {
return startsAt;
}
/**
* Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
*
* @param startsAt Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
*/
@JsonProperty(JSON_PROPERTY_STARTS_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStartsAt(String startsAt) {
this.startsAt = startsAt;
}
/**
* Return true if this Mandate object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Mandate mandate = (Mandate) o;
return Objects.equals(this.amount, mandate.amount) &&
Objects.equals(this.amountRule, mandate.amountRule) &&
Objects.equals(this.billingAttemptsRule, mandate.billingAttemptsRule) &&
Objects.equals(this.billingDay, mandate.billingDay) &&
Objects.equals(this.count, mandate.count) &&
Objects.equals(this.endsAt, mandate.endsAt) &&
Objects.equals(this.frequency, mandate.frequency) &&
Objects.equals(this.remarks, mandate.remarks) &&
Objects.equals(this.startsAt, mandate.startsAt);
}
@Override
public int hashCode() {
return Objects.hash(amount, amountRule, billingAttemptsRule, billingDay, count, endsAt, frequency, remarks, startsAt);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Mandate {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" amountRule: ").append(toIndentedString(amountRule)).append("\n");
sb.append(" billingAttemptsRule: ").append(toIndentedString(billingAttemptsRule)).append("\n");
sb.append(" billingDay: ").append(toIndentedString(billingDay)).append("\n");
sb.append(" count: ").append(toIndentedString(count)).append("\n");
sb.append(" endsAt: ").append(toIndentedString(endsAt)).append("\n");
sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n");
sb.append(" remarks: ").append(toIndentedString(remarks)).append("\n");
sb.append(" startsAt: ").append(toIndentedString(startsAt)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* Create an instance of Mandate given an JSON string
*
* @param jsonString JSON string
* @return An instance of Mandate
* @throws JsonProcessingException if the JSON string is invalid with respect to Mandate
*/
public static Mandate fromJson(String jsonString) throws JsonProcessingException {
return JSON.getMapper().readValue(jsonString, Mandate.class);
}
/**
* Convert an instance of Mandate to an JSON string
*
* @return JSON string
*/
public String toJson() throws JsonProcessingException {
return JSON.getMapper().writeValueAsString(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy