java.lang.Object
- com.adyen.model.storedvalue.StoredValueBalanceCheckRequest

public class StoredValueBalanceCheckRequest
extends Object

StoredValueBalanceCheckRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`StoredValueBalanceCheckRequest.ShopperInteractionEnum`	Specifies 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 String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_PAYMENT_METHOD`
`static String`	`JSON_PROPERTY_RECURRING_DETAIL_REFERENCE`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_INTERACTION`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_STORE`

Constructor Summary

Constructors
Constructor Description

StoredValueBalanceCheckRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`StoredValueBalanceCheckRequest`	`amount(Amount amount)`	amount
`boolean`	`equals(Object o)`	Return true if this StoredValueBalanceCheckRequest object is equal to o.
`static StoredValueBalanceCheckRequest`	`fromJson(String jsonString)`	Create an instance of StoredValueBalanceCheckRequest given an JSON string
`Amount`	`getAmount()`	amount
`String`	`getMerchantAccount()`	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 available
`String`	`getRecurringDetailReference()`	recurringDetailReference
`String`	`getReference()`	The reference to uniquely identify a payment.
`StoredValueBalanceCheckRequest.ShopperInteractionEnum`	`getShopperInteraction()`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`String`	`getShopperReference()`	shopperReference
`String`	`getStore()`	The physical store, for which this payment is processed.
`int`	`hashCode()`
`StoredValueBalanceCheckRequest`	`merchantAccount(String merchantAccount)`	The merchant account identifier, with which you want to process the transaction.
`StoredValueBalanceCheckRequest`	`paymentMethod(Map<String,String> paymentMethod)`	The collection that contains the type of the payment method and its specific information if available
`StoredValueBalanceCheckRequest`	`putPaymentMethodItem(String key, String paymentMethodItem)`
`StoredValueBalanceCheckRequest`	`recurringDetailReference(String recurringDetailReference)`	recurringDetailReference
`StoredValueBalanceCheckRequest`	`reference(String reference)`	The reference to uniquely identify a payment.
`void`	`setAmount(Amount amount)`	amount
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account identifier, with which you want to process the transaction.
`void`	`setPaymentMethod(Map<String,String> paymentMethod)`	The collection that contains the type of the payment method and its specific information if available
`void`	`setRecurringDetailReference(String recurringDetailReference)`	recurringDetailReference
`void`	`setReference(String reference)`	The reference to uniquely identify a payment.
`void`	`setShopperInteraction(StoredValueBalanceCheckRequest.ShopperInteractionEnum shopperInteraction)`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`void`	`setShopperReference(String shopperReference)`	shopperReference
`void`	`setStore(String store)`	The physical store, for which this payment is processed.
`StoredValueBalanceCheckRequest`	`shopperInteraction(StoredValueBalanceCheckRequest.ShopperInteractionEnum shopperInteraction)`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`StoredValueBalanceCheckRequest`	`shopperReference(String shopperReference)`	shopperReference
`StoredValueBalanceCheckRequest`	`store(String store)`	The physical store, for which this payment is processed.
`String`	`toJson()`	Convert an instance of StoredValueBalanceCheckRequest to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    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
- Constructor Detail
  - StoredValueBalanceCheckRequest
```
public StoredValueBalanceCheckRequest()
```
- Method Detail
  - amount
```
public StoredValueBalanceCheckRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - merchantAccount
```
public StoredValueBalanceCheckRequest merchantAccount(String merchantAccount)
```
    The merchant account identifier, with which you want to process the transaction.
    
    Parameters:
    
    merchantAccount -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - 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 StoredValueBalanceCheckRequest paymentMethod(Map<String,String> paymentMethod)
```
    The collection that contains the type of the payment method and its specific information if available
    
    Parameters:
    
    paymentMethod -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - putPaymentMethodItem
```
public StoredValueBalanceCheckRequest 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 StoredValueBalanceCheckRequest recurringDetailReference(String recurringDetailReference)
```
    recurringDetailReference
    
    Parameters:
    
    recurringDetailReference -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - getRecurringDetailReference
```
public String getRecurringDetailReference()
```
    recurringDetailReference
    
    Returns:
    
    recurringDetailReference
  - setRecurringDetailReference
```
public void setRecurringDetailReference(String recurringDetailReference)
```
    recurringDetailReference
    
    Parameters:
    
    recurringDetailReference -
  - reference
```
public StoredValueBalanceCheckRequest reference(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 -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - 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 StoredValueBalanceCheckRequest shopperInteraction(StoredValueBalanceCheckRequest.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 -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - getShopperInteraction
```
public StoredValueBalanceCheckRequest.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(StoredValueBalanceCheckRequest.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 StoredValueBalanceCheckRequest shopperReference(String shopperReference)
```
    shopperReference
    
    Parameters:
    
    shopperReference -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - getShopperReference
```
public String getShopperReference()
```
    shopperReference
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
    shopperReference
    
    Parameters:
    
    shopperReference -
  - store
```
public StoredValueBalanceCheckRequest store(String store)
```
    The physical store, for which this payment is processed.
    
    Parameters:
    
    store -
    
    Returns:
    
    the current StoredValueBalanceCheckRequest instance, allowing for method chaining
  - 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 StoredValueBalanceCheckRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static StoredValueBalanceCheckRequest fromJson(String jsonString)
                                               throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of StoredValueBalanceCheckRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of StoredValueBalanceCheckRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to StoredValueBalanceCheckRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of StoredValueBalanceCheckRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class StoredValueBalanceCheckRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_PAYMENT_METHOD

JSON_PROPERTY_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SHOPPER_INTERACTION

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_STORE

Constructor Detail

StoredValueBalanceCheckRequest

Method Detail

amount

getAmount

setAmount

merchantAccount

getMerchantAccount

setMerchantAccount

paymentMethod

putPaymentMethodItem

getPaymentMethod

setPaymentMethod

recurringDetailReference

getRecurringDetailReference

setRecurringDetailReference

reference

getReference

setReference

shopperInteraction

getShopperInteraction

setShopperInteraction

shopperReference

getShopperReference

setShopperReference

store

getStore

setStore

equals

hashCode

toString

fromJson

toJson