Package com.adyen.model.storedvalue
Class StoredValueLoadRequest
- java.lang.Object
-
- com.adyen.model.storedvalue.StoredValueLoadRequest
-
public class StoredValueLoadRequest extends Object
StoredValueLoadRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStoredValueLoadRequest.LoadTypeEnumThe type of load you are trying to do, when absent we default to 'Load'static classStoredValueLoadRequest.ShopperInteractionEnumSpecifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_AMOUNTstatic StringJSON_PROPERTY_LOAD_TYPEstatic StringJSON_PROPERTY_MERCHANT_ACCOUNTstatic StringJSON_PROPERTY_PAYMENT_METHODstatic StringJSON_PROPERTY_RECURRING_DETAIL_REFERENCEstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SHOPPER_INTERACTIONstatic StringJSON_PROPERTY_SHOPPER_REFERENCEstatic StringJSON_PROPERTY_STORE
-
Constructor Summary
Constructors Constructor Description StoredValueLoadRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StoredValueLoadRequestamount(Amount amount)booleanequals(Object o)Return true if this StoredValueLoadRequest object is equal to o.static StoredValueLoadRequestfromJson(String jsonString)Create an instance of StoredValueLoadRequest given an JSON stringAmountgetAmount()Get amountStoredValueLoadRequest.LoadTypeEnumgetLoadType()The type of load you are trying to do, when absent we default to 'Load'StringgetMerchantAccount()The merchant account identifier, with which you want to process the transaction.Map<String,String>getPaymentMethod()The collection that contains the type of the payment method and its specific information if availableStringgetRecurringDetailReference()Get recurringDetailReferenceStringgetReference()The reference to uniquely identify a payment.StoredValueLoadRequest.ShopperInteractionEnumgetShopperInteraction()Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.StringgetShopperReference()Get shopperReferenceStringgetStore()The physical store, for which this payment is processed.inthashCode()StoredValueLoadRequestloadType(StoredValueLoadRequest.LoadTypeEnum loadType)StoredValueLoadRequestmerchantAccount(String merchantAccount)StoredValueLoadRequestpaymentMethod(Map<String,String> paymentMethod)StoredValueLoadRequestputPaymentMethodItem(String key, String paymentMethodItem)StoredValueLoadRequestrecurringDetailReference(String recurringDetailReference)StoredValueLoadRequestreference(String reference)voidsetAmount(Amount amount)amountvoidsetLoadType(StoredValueLoadRequest.LoadTypeEnum loadType)The type of load you are trying to do, when absent we default to 'Load'voidsetMerchantAccount(String merchantAccount)The merchant account identifier, with which you want to process the transaction.voidsetPaymentMethod(Map<String,String> paymentMethod)The collection that contains the type of the payment method and its specific information if availablevoidsetRecurringDetailReference(String recurringDetailReference)recurringDetailReferencevoidsetReference(String reference)The reference to uniquely identify a payment.voidsetShopperInteraction(StoredValueLoadRequest.ShopperInteractionEnum shopperInteraction)Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.voidsetShopperReference(String shopperReference)shopperReferencevoidsetStore(String store)The physical store, for which this payment is processed.StoredValueLoadRequestshopperInteraction(StoredValueLoadRequest.ShopperInteractionEnum shopperInteraction)StoredValueLoadRequestshopperReference(String shopperReference)StoredValueLoadRequeststore(String store)StringtoJson()Convert an instance of StoredValueLoadRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LOAD_TYPE
public static final String JSON_PROPERTY_LOAD_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_METHOD
public static final String JSON_PROPERTY_PAYMENT_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_DETAIL_REFERENCE
public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_INTERACTION
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_REFERENCE
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE
public static final String JSON_PROPERTY_STORE
- See Also:
- Constant Field Values
-
-
Method Detail
-
amount
public StoredValueLoadRequest amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
amount- Parameters:
amount-
-
loadType
public StoredValueLoadRequest loadType(StoredValueLoadRequest.LoadTypeEnum loadType)
-
getLoadType
public StoredValueLoadRequest.LoadTypeEnum getLoadType()
The type of load you are trying to do, when absent we default to 'Load'- Returns:
- loadType
-
setLoadType
public void setLoadType(StoredValueLoadRequest.LoadTypeEnum loadType)
The type of load you are trying to do, when absent we default to 'Load'- Parameters:
loadType-
-
merchantAccount
public StoredValueLoadRequest merchantAccount(String merchantAccount)
-
getMerchantAccount
public String getMerchantAccount()
The merchant account identifier, with which you want to process the transaction.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
The merchant account identifier, with which you want to process the transaction.- Parameters:
merchantAccount-
-
paymentMethod
public StoredValueLoadRequest paymentMethod(Map<String,String> paymentMethod)
-
putPaymentMethodItem
public StoredValueLoadRequest putPaymentMethodItem(String key, String paymentMethodItem)
-
getPaymentMethod
public Map<String,String> getPaymentMethod()
The collection that contains the type of the payment method and its specific information if available- Returns:
- paymentMethod
-
setPaymentMethod
public void setPaymentMethod(Map<String,String> paymentMethod)
The collection that contains the type of the payment method and its specific information if available- Parameters:
paymentMethod-
-
recurringDetailReference
public StoredValueLoadRequest recurringDetailReference(String recurringDetailReference)
-
getRecurringDetailReference
public String getRecurringDetailReference()
Get recurringDetailReference- Returns:
- recurringDetailReference
-
setRecurringDetailReference
public void setRecurringDetailReference(String recurringDetailReference)
recurringDetailReference- Parameters:
recurringDetailReference-
-
reference
public StoredValueLoadRequest reference(String reference)
-
getReference
public String getReference()
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.- Returns:
- reference
-
setReference
public void setReference(String 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.- Parameters:
reference-
-
shopperInteraction
public StoredValueLoadRequest shopperInteraction(StoredValueLoadRequest.ShopperInteractionEnum shopperInteraction)
-
getShopperInteraction
public StoredValueLoadRequest.ShopperInteractionEnum getShopperInteraction()
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.- Returns:
- shopperInteraction
-
setShopperInteraction
public void setShopperInteraction(StoredValueLoadRequest.ShopperInteractionEnum 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.- Parameters:
shopperInteraction-
-
shopperReference
public StoredValueLoadRequest shopperReference(String shopperReference)
-
getShopperReference
public String getShopperReference()
Get shopperReference- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
shopperReference- Parameters:
shopperReference-
-
store
public StoredValueLoadRequest store(String store)
-
getStore
public String getStore()
The physical store, for which this payment is processed.- Returns:
- store
-
setStore
public void setStore(String store)
The physical store, for which this payment is processed.- Parameters:
store-
-
equals
public boolean equals(Object o)
Return true if this StoredValueLoadRequest object is equal to o.
-
fromJson
public static StoredValueLoadRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of StoredValueLoadRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of StoredValueLoadRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to StoredValueLoadRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of StoredValueLoadRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-