com.adyen.model.storedvalue.StoredValueLoadRequest 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 Stored Value API
*
* The version of the OpenAPI document: 46
*
*
* 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.storedvalue;
import java.util.Objects;
import java.util.Map;
import java.util.HashMap;
import com.adyen.model.storedvalue.Amount;
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 java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
/**
* StoredValueLoadRequest
*/
@JsonPropertyOrder({
StoredValueLoadRequest.JSON_PROPERTY_AMOUNT,
StoredValueLoadRequest.JSON_PROPERTY_LOAD_TYPE,
StoredValueLoadRequest.JSON_PROPERTY_MERCHANT_ACCOUNT,
StoredValueLoadRequest.JSON_PROPERTY_PAYMENT_METHOD,
StoredValueLoadRequest.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE,
StoredValueLoadRequest.JSON_PROPERTY_REFERENCE,
StoredValueLoadRequest.JSON_PROPERTY_SHOPPER_INTERACTION,
StoredValueLoadRequest.JSON_PROPERTY_SHOPPER_REFERENCE,
StoredValueLoadRequest.JSON_PROPERTY_STORE
})
public class StoredValueLoadRequest {
public static final String JSON_PROPERTY_AMOUNT = "amount";
private Amount amount;
/**
* The type of load you are trying to do, when absent we default to 'Load'
*/
public enum LoadTypeEnum {
MERCHANDISERETURN(String.valueOf("merchandiseReturn")),
LOAD(String.valueOf("load"));
private String value;
LoadTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static LoadTypeEnum fromValue(String value) {
for (LoadTypeEnum b : LoadTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_LOAD_TYPE = "loadType";
private LoadTypeEnum loadType;
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT = "merchantAccount";
private String merchantAccount;
public static final String JSON_PROPERTY_PAYMENT_METHOD = "paymentMethod";
private Map paymentMethod;
public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE = "recurringDetailReference";
private String recurringDetailReference;
public static final String JSON_PROPERTY_REFERENCE = "reference";
private String reference;
/**
* Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
*/
public enum ShopperInteractionEnum {
ECOMMERCE(String.valueOf("Ecommerce")),
CONTAUTH(String.valueOf("ContAuth")),
MOTO(String.valueOf("Moto")),
POS(String.valueOf("POS"));
private String value;
ShopperInteractionEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static ShopperInteractionEnum fromValue(String value) {
for (ShopperInteractionEnum b : ShopperInteractionEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_SHOPPER_INTERACTION = "shopperInteraction";
private ShopperInteractionEnum shopperInteraction;
public static final String JSON_PROPERTY_SHOPPER_REFERENCE = "shopperReference";
private String shopperReference;
public static final String JSON_PROPERTY_STORE = "store";
private String store;
public StoredValueLoadRequest() {
}
/**
* amount
*
* @param amount
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest amount(Amount amount) {
this.amount = amount;
return this;
}
/**
* Get amount
* @return amount
*/
@JsonProperty(JSON_PROPERTY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Amount getAmount() {
return amount;
}
/**
* amount
*
* @param amount
*/
@JsonProperty(JSON_PROPERTY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAmount(Amount amount) {
this.amount = amount;
}
/**
* The type of load you are trying to do, when absent we default to 'Load'
*
* @param loadType The type of load you are trying to do, when absent we default to 'Load'
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest loadType(LoadTypeEnum loadType) {
this.loadType = loadType;
return this;
}
/**
* The type of load you are trying to do, when absent we default to 'Load'
* @return loadType The type of load you are trying to do, when absent we default to 'Load'
*/
@JsonProperty(JSON_PROPERTY_LOAD_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public LoadTypeEnum getLoadType() {
return loadType;
}
/**
* The type of load you are trying to do, when absent we default to 'Load'
*
* @param loadType The type of load you are trying to do, when absent we default to 'Load'
*/
@JsonProperty(JSON_PROPERTY_LOAD_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLoadType(LoadTypeEnum loadType) {
this.loadType = loadType;
}
/**
* The merchant account identifier, with which you want to process the transaction.
*
* @param merchantAccount The merchant account identifier, with which you want to process the transaction.
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest merchantAccount(String merchantAccount) {
this.merchantAccount = merchantAccount;
return this;
}
/**
* The merchant account identifier, with which you want to process the transaction.
* @return merchantAccount The merchant account identifier, with which you want to process the transaction.
*/
@JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getMerchantAccount() {
return merchantAccount;
}
/**
* The merchant account identifier, with which you want to process the transaction.
*
* @param merchantAccount The merchant account identifier, with which you want to process the transaction.
*/
@JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMerchantAccount(String merchantAccount) {
this.merchantAccount = merchantAccount;
}
/**
* The collection that contains the type of the payment method and its specific information if available
*
* @param paymentMethod The collection that contains the type of the payment method and its specific information if available
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest paymentMethod(Map paymentMethod) {
this.paymentMethod = paymentMethod;
return this;
}
public StoredValueLoadRequest putPaymentMethodItem(String key, String paymentMethodItem) {
if (this.paymentMethod == null) {
this.paymentMethod = new HashMap<>();
}
this.paymentMethod.put(key, paymentMethodItem);
return this;
}
/**
* The collection that contains the type of the payment method and its specific information if available
* @return paymentMethod The collection that contains the type of the payment method and its specific information if available
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_METHOD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Map getPaymentMethod() {
return paymentMethod;
}
/**
* The collection that contains the type of the payment method and its specific information if available
*
* @param paymentMethod The collection that contains the type of the payment method and its specific information if available
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_METHOD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPaymentMethod(Map paymentMethod) {
this.paymentMethod = paymentMethod;
}
/**
* recurringDetailReference
*
* @param recurringDetailReference
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest recurringDetailReference(String recurringDetailReference) {
this.recurringDetailReference = recurringDetailReference;
return this;
}
/**
* Get recurringDetailReference
* @return recurringDetailReference
*/
@JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getRecurringDetailReference() {
return recurringDetailReference;
}
/**
* recurringDetailReference
*
* @param recurringDetailReference
*/
@JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setRecurringDetailReference(String recurringDetailReference) {
this.recurringDetailReference = recurringDetailReference;
}
/**
* The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
*
* @param reference The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest reference(String reference) {
this.reference = reference;
return this;
}
/**
* The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
* @return reference The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
*/
@JsonProperty(JSON_PROPERTY_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getReference() {
return reference;
}
/**
* The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
*
* @param reference The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
*/
@JsonProperty(JSON_PROPERTY_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReference(String reference) {
this.reference = reference;
}
/**
* Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
*
* @param shopperInteraction Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest shopperInteraction(ShopperInteractionEnum shopperInteraction) {
this.shopperInteraction = shopperInteraction;
return this;
}
/**
* Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
* @return shopperInteraction Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
*/
@JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ShopperInteractionEnum getShopperInteraction() {
return shopperInteraction;
}
/**
* Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
*
* @param shopperInteraction Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
*/
@JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) {
this.shopperInteraction = shopperInteraction;
}
/**
* shopperReference
*
* @param shopperReference
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest shopperReference(String shopperReference) {
this.shopperReference = shopperReference;
return this;
}
/**
* Get shopperReference
* @return shopperReference
*/
@JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getShopperReference() {
return shopperReference;
}
/**
* shopperReference
*
* @param shopperReference
*/
@JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShopperReference(String shopperReference) {
this.shopperReference = shopperReference;
}
/**
* The physical store, for which this payment is processed.
*
* @param store The physical store, for which this payment is processed.
* @return the current {@code StoredValueLoadRequest} instance, allowing for method chaining
*/
public StoredValueLoadRequest store(String store) {
this.store = store;
return this;
}
/**
* The physical store, for which this payment is processed.
* @return store The physical store, for which this payment is processed.
*/
@JsonProperty(JSON_PROPERTY_STORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStore() {
return store;
}
/**
* The physical store, for which this payment is processed.
*
* @param store The physical store, for which this payment is processed.
*/
@JsonProperty(JSON_PROPERTY_STORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStore(String store) {
this.store = store;
}
/**
* Return true if this StoredValueLoadRequest object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
StoredValueLoadRequest storedValueLoadRequest = (StoredValueLoadRequest) o;
return Objects.equals(this.amount, storedValueLoadRequest.amount) &&
Objects.equals(this.loadType, storedValueLoadRequest.loadType) &&
Objects.equals(this.merchantAccount, storedValueLoadRequest.merchantAccount) &&
Objects.equals(this.paymentMethod, storedValueLoadRequest.paymentMethod) &&
Objects.equals(this.recurringDetailReference, storedValueLoadRequest.recurringDetailReference) &&
Objects.equals(this.reference, storedValueLoadRequest.reference) &&
Objects.equals(this.shopperInteraction, storedValueLoadRequest.shopperInteraction) &&
Objects.equals(this.shopperReference, storedValueLoadRequest.shopperReference) &&
Objects.equals(this.store, storedValueLoadRequest.store);
}
@Override
public int hashCode() {
return Objects.hash(amount, loadType, merchantAccount, paymentMethod, recurringDetailReference, reference, shopperInteraction, shopperReference, store);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class StoredValueLoadRequest {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" loadType: ").append(toIndentedString(loadType)).append("\n");
sb.append(" merchantAccount: ").append(toIndentedString(merchantAccount)).append("\n");
sb.append(" paymentMethod: ").append(toIndentedString(paymentMethod)).append("\n");
sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n");
sb.append(" reference: ").append(toIndentedString(reference)).append("\n");
sb.append(" shopperInteraction: ").append(toIndentedString(shopperInteraction)).append("\n");
sb.append(" shopperReference: ").append(toIndentedString(shopperReference)).append("\n");
sb.append(" store: ").append(toIndentedString(store)).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 StoredValueLoadRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of StoredValueLoadRequest
* @throws JsonProcessingException if the JSON string is invalid with respect to StoredValueLoadRequest
*/
public static StoredValueLoadRequest fromJson(String jsonString) throws JsonProcessingException {
return JSON.getMapper().readValue(jsonString, StoredValueLoadRequest.class);
}
/**
* Convert an instance of StoredValueLoadRequest to an JSON string
*
* @return JSON string
*/
public String toJson() throws JsonProcessingException {
return JSON.getMapper().writeValueAsString(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy