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

public class BalanceCheckRequest
extends Object

BalanceCheckRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`BalanceCheckRequest.RecurringProcessingModelEnum`	Defines a recurring payment type.
`static class`	`BalanceCheckRequest.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_ACCOUNT_INFO`
`static String`	`JSON_PROPERTY_ADDITIONAL_AMOUNT`
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_APPLICATION_INFO`
`static String`	`JSON_PROPERTY_BILLING_ADDRESS`
`static String`	`JSON_PROPERTY_BROWSER_INFO`
`static String`	`JSON_PROPERTY_CAPTURE_DELAY_HOURS`
`static String`	`JSON_PROPERTY_DATE_OF_BIRTH`
`static String`	`JSON_PROPERTY_DCC_QUOTE`
`static String`	`JSON_PROPERTY_DELIVERY_ADDRESS`
`static String`	`JSON_PROPERTY_DELIVERY_DATE`
`static String`	`JSON_PROPERTY_DEVICE_FINGERPRINT`
`static String`	`JSON_PROPERTY_FRAUD_OFFSET`
`static String`	`JSON_PROPERTY_INSTALLMENTS`
`static String`	`JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT`
`static String`	`JSON_PROPERTY_MCC`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_MERCHANT_ORDER_REFERENCE`
`static String`	`JSON_PROPERTY_MERCHANT_RISK_INDICATOR`
`static String`	`JSON_PROPERTY_METADATA`
`static String`	`JSON_PROPERTY_ORDER_REFERENCE`
`static String`	`JSON_PROPERTY_PAYMENT_METHOD`
`static String`	`JSON_PROPERTY_RECURRING`
`static String`	`JSON_PROPERTY_RECURRING_PROCESSING_MODEL`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SELECTED_BRAND`
`static String`	`JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE`
`static String`	`JSON_PROPERTY_SESSION_ID`
`static String`	`JSON_PROPERTY_SHOPPER_EMAIL`
`static String`	`JSON_PROPERTY_SHOPPER_I_P`
`static String`	`JSON_PROPERTY_SHOPPER_INTERACTION`
`static String`	`JSON_PROPERTY_SHOPPER_LOCALE`
`static String`	`JSON_PROPERTY_SHOPPER_NAME`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_STATEMENT`
`static String`	`JSON_PROPERTY_SOCIAL_SECURITY_NUMBER`
`static String`	`JSON_PROPERTY_SPLITS`
`static String`	`JSON_PROPERTY_STORE`
`static String`	`JSON_PROPERTY_TELEPHONE_NUMBER`
`static String`	`JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY`
`static String`	`JSON_PROPERTY_THREE_D_S2_REQUEST_DATA`
`static String`	`JSON_PROPERTY_TOTALS_GROUP`
`static String`	`JSON_PROPERTY_TRUSTED_SHOPPER`

Constructor Summary

Constructors
Constructor Description

BalanceCheckRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`BalanceCheckRequest`	`accountInfo(AccountInfo accountInfo)`
`BalanceCheckRequest`	`additionalAmount(Amount additionalAmount)`
`BalanceCheckRequest`	`additionalData(Map<String,String> additionalData)`
`BalanceCheckRequest`	`addSplitsItem(Split splitsItem)`
`BalanceCheckRequest`	`amount(Amount amount)`
`BalanceCheckRequest`	`applicationInfo(ApplicationInfo applicationInfo)`
`BalanceCheckRequest`	`billingAddress(Address billingAddress)`
`BalanceCheckRequest`	`browserInfo(BrowserInfo browserInfo)`
`BalanceCheckRequest`	`captureDelayHours(Integer captureDelayHours)`
`BalanceCheckRequest`	`dateOfBirth(LocalDate dateOfBirth)`
`BalanceCheckRequest`	`dccQuote(ForexQuote dccQuote)`
`BalanceCheckRequest`	`deliveryAddress(Address deliveryAddress)`
`BalanceCheckRequest`	`deliveryDate(OffsetDateTime deliveryDate)`
`BalanceCheckRequest`	`deviceFingerprint(String deviceFingerprint)`
`boolean`	`equals(Object o)`	Return true if this BalanceCheckRequest object is equal to o.
`BalanceCheckRequest`	`fraudOffset(Integer fraudOffset)`
`static BalanceCheckRequest`	`fromJson(String jsonString)`	Create an instance of BalanceCheckRequest given an JSON string
`AccountInfo`	`getAccountInfo()`	Get accountInfo
`Amount`	`getAdditionalAmount()`	Get additionalAmount
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular payment request.
`Amount`	`getAmount()`	Get amount
`ApplicationInfo`	`getApplicationInfo()`	Get applicationInfo
`Address`	`getBillingAddress()`	Get billingAddress
`BrowserInfo`	`getBrowserInfo()`	Get browserInfo
`Integer`	`getCaptureDelayHours()`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`LocalDate`	`getDateOfBirth()`	The shopper's date of birth.
`ForexQuote`	`getDccQuote()`	Get dccQuote
`Address`	`getDeliveryAddress()`	Get deliveryAddress
`OffsetDateTime`	`getDeliveryDate()`	The date and time the purchased goods should be delivered.
`String`	`getDeviceFingerprint()`	A string containing the shopper's device fingerprint.
`Integer`	`getFraudOffset()`	An integer value that is added to the normal fraud score.
`Installments`	`getInstallments()`	Get installments
`Map<String,String>`	`getLocalizedShopperStatement()`	The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
`String`	`getMcc()`	The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment.
`String`	`getMerchantAccount()`	The merchant account identifier, with which you want to process the transaction.
`String`	`getMerchantOrderReference()`	This reference allows linking multiple transactions to each other for reporting purposes (i.e.
`MerchantRiskIndicator`	`getMerchantRiskIndicator()`	Get merchantRiskIndicator
`Map<String,String>`	`getMetadata()`	Metadata consists of entries, each of which includes a key and a value.
`String`	`getOrderReference()`	When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
`Map<String,String>`	`getPaymentMethod()`	The collection that contains the type of the payment method and its specific information.
`Recurring`	`getRecurring()`	Get recurring
`BalanceCheckRequest.RecurringProcessingModelEnum`	`getRecurringProcessingModel()`	Defines a recurring payment type.
`String`	`getReference()`	The reference to uniquely identify a payment.
`String`	`getSelectedBrand()`	Some payment methods require defining a value for this field to specify how to process the transaction.
`String`	`getSelectedRecurringDetailReference()`	The `recurringDetailReference` you want to use for this payment.
`String`	`getSessionId()`	A session ID used to identify a payment session.
`String`	`getShopperEmail()`	The shopper's email address.
`BalanceCheckRequest.ShopperInteractionEnum`	`getShopperInteraction()`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`String`	`getShopperIP()`	The shopper's IP address.
`String`	`getShopperLocale()`	The combination of a language code and a country code to specify the language to be used in the payment.
`Name`	`getShopperName()`	Get shopperName
`String`	`getShopperReference()`	Required for recurring payments.
`String`	`getShopperStatement()`	The text to be shown on the shopper's bank statement.
`String`	`getSocialSecurityNumber()`	The shopper's social security number.
`List<Split>`	`getSplits()`	An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
`String`	`getStore()`	The ecommerce or point-of-sale store that is processing the payment.
`String`	`getTelephoneNumber()`	The shopper's telephone number.
`ThreeDS2RequestData`	`getThreeDS2RequestData()`	Get threeDS2RequestData
`Boolean`	`getThreeDSAuthenticationOnly()`	Deprecated.
`String`	`getTotalsGroup()`	The reference value to aggregate sales totals in reporting.
`Boolean`	`getTrustedShopper()`	Set to true if the payment should be routed to a trusted MID.
`int`	`hashCode()`
`BalanceCheckRequest`	`installments(Installments installments)`
`BalanceCheckRequest`	`localizedShopperStatement(Map<String,String> localizedShopperStatement)`
`BalanceCheckRequest`	`mcc(String mcc)`
`BalanceCheckRequest`	`merchantAccount(String merchantAccount)`
`BalanceCheckRequest`	`merchantOrderReference(String merchantOrderReference)`
`BalanceCheckRequest`	`merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`
`BalanceCheckRequest`	`metadata(Map<String,String> metadata)`
`BalanceCheckRequest`	`orderReference(String orderReference)`
`BalanceCheckRequest`	`paymentMethod(Map<String,String> paymentMethod)`
`BalanceCheckRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`BalanceCheckRequest`	`putLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)`
`BalanceCheckRequest`	`putMetadataItem(String key, String metadataItem)`
`BalanceCheckRequest`	`putPaymentMethodItem(String key, String paymentMethodItem)`
`BalanceCheckRequest`	`recurring(Recurring recurring)`
`BalanceCheckRequest`	`recurringProcessingModel(BalanceCheckRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`BalanceCheckRequest`	`reference(String reference)`
`BalanceCheckRequest`	`selectedBrand(String selectedBrand)`
`BalanceCheckRequest`	`selectedRecurringDetailReference(String selectedRecurringDetailReference)`
`BalanceCheckRequest`	`sessionId(String sessionId)`
`void`	`setAccountInfo(AccountInfo accountInfo)`
`void`	`setAdditionalAmount(Amount additionalAmount)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAmount(Amount amount)`
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`
`void`	`setBillingAddress(Address billingAddress)`
`void`	`setBrowserInfo(BrowserInfo browserInfo)`
`void`	`setCaptureDelayHours(Integer captureDelayHours)`
`void`	`setDateOfBirth(LocalDate dateOfBirth)`
`void`	`setDccQuote(ForexQuote dccQuote)`
`void`	`setDeliveryAddress(Address deliveryAddress)`
`void`	`setDeliveryDate(OffsetDateTime deliveryDate)`
`void`	`setDeviceFingerprint(String deviceFingerprint)`
`void`	`setFraudOffset(Integer fraudOffset)`
`void`	`setInstallments(Installments installments)`
`void`	`setLocalizedShopperStatement(Map<String,String> localizedShopperStatement)`
`void`	`setMcc(String mcc)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setMerchantOrderReference(String merchantOrderReference)`
`void`	`setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setOrderReference(String orderReference)`
`void`	`setPaymentMethod(Map<String,String> paymentMethod)`
`void`	`setRecurring(Recurring recurring)`
`void`	`setRecurringProcessingModel(BalanceCheckRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`void`	`setReference(String reference)`
`void`	`setSelectedBrand(String selectedBrand)`
`void`	`setSelectedRecurringDetailReference(String selectedRecurringDetailReference)`
`void`	`setSessionId(String sessionId)`
`void`	`setShopperEmail(String shopperEmail)`
`void`	`setShopperInteraction(BalanceCheckRequest.ShopperInteractionEnum shopperInteraction)`
`void`	`setShopperIP(String shopperIP)`
`void`	`setShopperLocale(String shopperLocale)`
`void`	`setShopperName(Name shopperName)`
`void`	`setShopperReference(String shopperReference)`
`void`	`setShopperStatement(String shopperStatement)`
`void`	`setSocialSecurityNumber(String socialSecurityNumber)`
`void`	`setSplits(List<Split> splits)`
`void`	`setStore(String store)`
`void`	`setTelephoneNumber(String telephoneNumber)`
`void`	`setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)`
`void`	`setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`	Deprecated.
`void`	`setTotalsGroup(String totalsGroup)`
`void`	`setTrustedShopper(Boolean trustedShopper)`
`BalanceCheckRequest`	`shopperEmail(String shopperEmail)`
`BalanceCheckRequest`	`shopperInteraction(BalanceCheckRequest.ShopperInteractionEnum shopperInteraction)`
`BalanceCheckRequest`	`shopperIP(String shopperIP)`
`BalanceCheckRequest`	`shopperLocale(String shopperLocale)`
`BalanceCheckRequest`	`shopperName(Name shopperName)`
`BalanceCheckRequest`	`shopperReference(String shopperReference)`
`BalanceCheckRequest`	`shopperStatement(String shopperStatement)`
`BalanceCheckRequest`	`socialSecurityNumber(String socialSecurityNumber)`
`BalanceCheckRequest`	`splits(List<Split> splits)`
`BalanceCheckRequest`	`store(String store)`
`BalanceCheckRequest`	`telephoneNumber(String telephoneNumber)`
`BalanceCheckRequest`	`threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)`
`BalanceCheckRequest`	`threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`
`String`	`toJson()`	Convert an instance of BalanceCheckRequest to an JSON string
`String`	`toString()`
`BalanceCheckRequest`	`totalsGroup(String totalsGroup)`
`BalanceCheckRequest`	`trustedShopper(Boolean trustedShopper)`

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

- Field Detail
  - JSON_PROPERTY_ACCOUNT_INFO
```
public static final String JSON_PROPERTY_ACCOUNT_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ADDITIONAL_AMOUNT
```
public static final String JSON_PROPERTY_ADDITIONAL_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ADDITIONAL_DATA
```
public static final String JSON_PROPERTY_ADDITIONAL_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_APPLICATION_INFO
```
public static final String JSON_PROPERTY_APPLICATION_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BILLING_ADDRESS
```
public static final String JSON_PROPERTY_BILLING_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BROWSER_INFO
```
public static final String JSON_PROPERTY_BROWSER_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAPTURE_DELAY_HOURS
```
public static final String JSON_PROPERTY_CAPTURE_DELAY_HOURS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DATE_OF_BIRTH
```
public static final String JSON_PROPERTY_DATE_OF_BIRTH
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DCC_QUOTE
```
public static final String JSON_PROPERTY_DCC_QUOTE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELIVERY_ADDRESS
```
public static final String JSON_PROPERTY_DELIVERY_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELIVERY_DATE
```
public static final String JSON_PROPERTY_DELIVERY_DATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DEVICE_FINGERPRINT
```
public static final String JSON_PROPERTY_DEVICE_FINGERPRINT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FRAUD_OFFSET
```
public static final String JSON_PROPERTY_FRAUD_OFFSET
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INSTALLMENTS
```
public static final String JSON_PROPERTY_INSTALLMENTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT
```
public static final String JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MCC
```
public static final String JSON_PROPERTY_MCC
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
```
public static final String JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_RISK_INDICATOR
```
public static final String JSON_PROPERTY_MERCHANT_RISK_INDICATOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_METADATA
```
public static final String JSON_PROPERTY_METADATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ORDER_REFERENCE
```
public static final String JSON_PROPERTY_ORDER_REFERENCE
```
    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
```
public static final String JSON_PROPERTY_RECURRING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RECURRING_PROCESSING_MODEL
```
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SELECTED_BRAND
```
public static final String JSON_PROPERTY_SELECTED_BRAND
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
```
public static final String JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SESSION_ID
```
public static final String JSON_PROPERTY_SESSION_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_EMAIL
```
public static final String JSON_PROPERTY_SHOPPER_EMAIL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_I_P
```
public static final String JSON_PROPERTY_SHOPPER_I_P
```
    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_LOCALE
```
public static final String JSON_PROPERTY_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_NAME
```
public static final String JSON_PROPERTY_SHOPPER_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_STATEMENT
```
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SPLITS
```
public static final String JSON_PROPERTY_SPLITS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE
```
public static final String JSON_PROPERTY_STORE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TELEPHONE_NUMBER
```
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
```
public static final String JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
```
public static final String JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOTALS_GROUP
```
public static final String JSON_PROPERTY_TOTALS_GROUP
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRUSTED_SHOPPER
```
public static final String JSON_PROPERTY_TRUSTED_SHOPPER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BalanceCheckRequest
```
public BalanceCheckRequest()
```
- Method Detail
  - accountInfo
```
public BalanceCheckRequest accountInfo(AccountInfo accountInfo)
```
  - getAccountInfo
```
public AccountInfo getAccountInfo()
```
    Get accountInfo
    
    Returns:
    
    accountInfo
  - setAccountInfo
```
public void setAccountInfo(AccountInfo accountInfo)
```
  - additionalAmount
```
public BalanceCheckRequest additionalAmount(Amount additionalAmount)
```
  - getAdditionalAmount
```
public Amount getAdditionalAmount()
```
    Get additionalAmount
    
    Returns:
    
    additionalAmount
  - setAdditionalAmount
```
public void setAdditionalAmount(Amount additionalAmount)
```
  - additionalData
```
public BalanceCheckRequest additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public BalanceCheckRequest putAdditionalDataItem(String key,
                                                 String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
  - amount
```
public BalanceCheckRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - applicationInfo
```
public BalanceCheckRequest applicationInfo(ApplicationInfo applicationInfo)
```
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    Get applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
  - billingAddress
```
public BalanceCheckRequest billingAddress(Address billingAddress)
```
  - getBillingAddress
```
public Address getBillingAddress()
```
    Get billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
  - browserInfo
```
public BalanceCheckRequest browserInfo(BrowserInfo browserInfo)
```
  - getBrowserInfo
```
public BrowserInfo getBrowserInfo()
```
    Get browserInfo
    
    Returns:
    
    browserInfo
  - setBrowserInfo
```
public void setBrowserInfo(BrowserInfo browserInfo)
```
  - captureDelayHours
```
public BalanceCheckRequest captureDelayHours(Integer captureDelayHours)
```
  - getCaptureDelayHours
```
public Integer getCaptureDelayHours()
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Returns:
    
    captureDelayHours
  - setCaptureDelayHours
```
public void setCaptureDelayHours(Integer captureDelayHours)
```
  - dateOfBirth
```
public BalanceCheckRequest dateOfBirth(LocalDate dateOfBirth)
```
  - getDateOfBirth
```
public LocalDate getDateOfBirth()
```
    The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
    
    Returns:
    
    dateOfBirth
  - setDateOfBirth
```
public void setDateOfBirth(LocalDate dateOfBirth)
```
  - dccQuote
```
public BalanceCheckRequest dccQuote(ForexQuote dccQuote)
```
  - getDccQuote
```
public ForexQuote getDccQuote()
```
    Get dccQuote
    
    Returns:
    
    dccQuote
  - setDccQuote
```
public void setDccQuote(ForexQuote dccQuote)
```
  - deliveryAddress
```
public BalanceCheckRequest deliveryAddress(Address deliveryAddress)
```
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    Get deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
  - deliveryDate
```
public BalanceCheckRequest deliveryDate(OffsetDateTime deliveryDate)
```
  - getDeliveryDate
```
public OffsetDateTime getDeliveryDate()
```
    The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
    
    Returns:
    
    deliveryDate
  - setDeliveryDate
```
public void setDeliveryDate(OffsetDateTime deliveryDate)
```
  - deviceFingerprint
```
public BalanceCheckRequest deviceFingerprint(String deviceFingerprint)
```
  - getDeviceFingerprint
```
public String getDeviceFingerprint()
```
    A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
    
    Returns:
    
    deviceFingerprint
  - setDeviceFingerprint
```
public void setDeviceFingerprint(String deviceFingerprint)
```
  - fraudOffset
```
public BalanceCheckRequest fraudOffset(Integer fraudOffset)
```
  - getFraudOffset
```
public Integer getFraudOffset()
```
    An integer value that is added to the normal fraud score. The value can be either positive or negative.
    
    Returns:
    
    fraudOffset
  - setFraudOffset
```
public void setFraudOffset(Integer fraudOffset)
```
  - installments
```
public BalanceCheckRequest installments(Installments installments)
```
  - getInstallments
```
public Installments getInstallments()
```
    Get installments
    
    Returns:
    
    installments
  - setInstallments
```
public void setInstallments(Installments installments)
```
  - localizedShopperStatement
```
public BalanceCheckRequest localizedShopperStatement(Map<String,String> localizedShopperStatement)
```
  - putLocalizedShopperStatementItem
```
public BalanceCheckRequest putLocalizedShopperStatementItem(String key,
                                                            String localizedShopperStatementItem)
```
  - getLocalizedShopperStatement
```
public Map<String,String> getLocalizedShopperStatement()
```
    The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters.
    
    Returns:
    
    localizedShopperStatement
  - setLocalizedShopperStatement
```
public void setLocalizedShopperStatement(Map<String,String> localizedShopperStatement)
```
  - mcc
```
public BalanceCheckRequest mcc(String mcc)
```
  - getMcc
```
public String getMcc()
```
    The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    
    Returns:
    
    mcc
  - setMcc
```
public void setMcc(String mcc)
```
  - merchantAccount
```
public BalanceCheckRequest 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)
```
  - merchantOrderReference
```
public BalanceCheckRequest merchantOrderReference(String merchantOrderReference)
```
  - getMerchantOrderReference
```
public String getMerchantOrderReference()
```
    This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.
    
    Returns:
    
    merchantOrderReference
  - setMerchantOrderReference
```
public void setMerchantOrderReference(String merchantOrderReference)
```
  - merchantRiskIndicator
```
public BalanceCheckRequest merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
  - getMerchantRiskIndicator
```
public MerchantRiskIndicator getMerchantRiskIndicator()
```
    Get merchantRiskIndicator
    
    Returns:
    
    merchantRiskIndicator
  - setMerchantRiskIndicator
```
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
  - metadata
```
public BalanceCheckRequest metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public BalanceCheckRequest putMetadataItem(String key,
                                           String metadataItem)
```
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value.
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(Map<String,String> metadata)
```
  - orderReference
```
public BalanceCheckRequest orderReference(String orderReference)
```
  - getOrderReference
```
public String getOrderReference()
```
    When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
    
    Returns:
    
    orderReference
  - setOrderReference
```
public void setOrderReference(String orderReference)
```
  - paymentMethod
```
public BalanceCheckRequest paymentMethod(Map<String,String> paymentMethod)
```
  - putPaymentMethodItem
```
public BalanceCheckRequest 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.
    
    Returns:
    
    paymentMethod
  - setPaymentMethod
```
public void setPaymentMethod(Map<String,String> paymentMethod)
```
  - recurring
```
public BalanceCheckRequest recurring(Recurring recurring)
```
  - getRecurring
```
public Recurring getRecurring()
```
    Get recurring
    
    Returns:
    
    recurring
  - setRecurring
```
public void setRecurring(Recurring recurring)
```
  - recurringProcessingModel
```
public BalanceCheckRequest recurringProcessingModel(BalanceCheckRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - getRecurringProcessingModel
```
public BalanceCheckRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
```
    Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Returns:
    
    recurringProcessingModel
  - setRecurringProcessingModel
```
public void setRecurringProcessingModel(BalanceCheckRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - reference
```
public BalanceCheckRequest 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)
```
  - selectedBrand
```
public BalanceCheckRequest selectedBrand(String selectedBrand)
```
  - getSelectedBrand
```
public String getSelectedBrand()
```
    Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.
    
    Returns:
    
    selectedBrand
  - setSelectedBrand
```
public void setSelectedBrand(String selectedBrand)
```
  - selectedRecurringDetailReference
```
public BalanceCheckRequest selectedRecurringDetailReference(String selectedRecurringDetailReference)
```
  - getSelectedRecurringDetailReference
```
public String getSelectedRecurringDetailReference()
```
    The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
    
    Returns:
    
    selectedRecurringDetailReference
  - setSelectedRecurringDetailReference
```
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
```
  - sessionId
```
public BalanceCheckRequest sessionId(String sessionId)
```
  - getSessionId
```
public String getSessionId()
```
    A session ID used to identify a payment session.
    
    Returns:
    
    sessionId
  - setSessionId
```
public void setSessionId(String sessionId)
```
  - shopperEmail
```
public BalanceCheckRequest shopperEmail(String shopperEmail)
```
  - getShopperEmail
```
public String getShopperEmail()
```
    The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
  - shopperIP
```
public BalanceCheckRequest shopperIP(String shopperIP)
```
  - getShopperIP
```
public String getShopperIP()
```
    The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
    
    Returns:
    
    shopperIP
  - setShopperIP
```
public void setShopperIP(String shopperIP)
```
  - shopperInteraction
```
public BalanceCheckRequest shopperInteraction(BalanceCheckRequest.ShopperInteractionEnum shopperInteraction)
```
  - getShopperInteraction
```
public BalanceCheckRequest.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(BalanceCheckRequest.ShopperInteractionEnum shopperInteraction)
```
  - shopperLocale
```
public BalanceCheckRequest shopperLocale(String shopperLocale)
```
  - getShopperLocale
```
public String getShopperLocale()
```
    The combination of a language code and a country code to specify the language to be used in the payment.
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
  - shopperName
```
public BalanceCheckRequest shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
  - shopperReference
```
public BalanceCheckRequest shopperReference(String shopperReference)
```
  - getShopperReference
```
public String getShopperReference()
```
    Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
  - shopperStatement
```
public BalanceCheckRequest shopperStatement(String shopperStatement)
```
  - getShopperStatement
```
public String getShopperStatement()
```
    The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.
    
    Returns:
    
    shopperStatement
  - setShopperStatement
```
public void setShopperStatement(String shopperStatement)
```
  - socialSecurityNumber
```
public BalanceCheckRequest socialSecurityNumber(String socialSecurityNumber)
```
  - getSocialSecurityNumber
```
public String getSocialSecurityNumber()
```
    The shopper's social security number.
    
    Returns:
    
    socialSecurityNumber
  - setSocialSecurityNumber
```
public void setSocialSecurityNumber(String socialSecurityNumber)
```
  - splits
```
public BalanceCheckRequest splits(List<Split> splits)
```
  - addSplitsItem
```
public BalanceCheckRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
    
    Returns:
    
    splits
  - setSplits
```
public void setSplits(List<Split> splits)
```
  - store
```
public BalanceCheckRequest store(String store)
```
  - getStore
```
public String getStore()
```
    The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
  - telephoneNumber
```
public BalanceCheckRequest telephoneNumber(String telephoneNumber)
```
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
  - threeDS2RequestData
```
public BalanceCheckRequest threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
```
  - getThreeDS2RequestData
```
public ThreeDS2RequestData getThreeDS2RequestData()
```
    Get threeDS2RequestData
    
    Returns:
    
    threeDS2RequestData
  - setThreeDS2RequestData
```
public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
```
  - threeDSAuthenticationOnly
```
public BalanceCheckRequest threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
```
  - getThreeDSAuthenticationOnly
```
@Deprecated
public Boolean getThreeDSAuthenticationOnly()
```
    Deprecated.
    
    If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
    
    Returns:
    
    threeDSAuthenticationOnly
  - setThreeDSAuthenticationOnly
```
@Deprecated
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
```
    Deprecated.
  - totalsGroup
```
public BalanceCheckRequest totalsGroup(String totalsGroup)
```
  - getTotalsGroup
```
public String getTotalsGroup()
```
    The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
    
    Returns:
    
    totalsGroup
  - setTotalsGroup
```
public void setTotalsGroup(String totalsGroup)
```
  - trustedShopper
```
public BalanceCheckRequest trustedShopper(Boolean trustedShopper)
```
  - getTrustedShopper
```
public Boolean getTrustedShopper()
```
    Set to true if the payment should be routed to a trusted MID.
    
    Returns:
    
    trustedShopper
  - setTrustedShopper
```
public void setTrustedShopper(Boolean trustedShopper)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this BalanceCheckRequest 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 BalanceCheckRequest fromJson(String jsonString)
                                    throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of BalanceCheckRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of BalanceCheckRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to BalanceCheckRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of BalanceCheckRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class BalanceCheckRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACCOUNT_INFO

JSON_PROPERTY_ADDITIONAL_AMOUNT

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_APPLICATION_INFO

JSON_PROPERTY_BILLING_ADDRESS

JSON_PROPERTY_BROWSER_INFO

JSON_PROPERTY_CAPTURE_DELAY_HOURS

JSON_PROPERTY_DATE_OF_BIRTH

JSON_PROPERTY_DCC_QUOTE

JSON_PROPERTY_DELIVERY_ADDRESS

JSON_PROPERTY_DELIVERY_DATE

JSON_PROPERTY_DEVICE_FINGERPRINT

JSON_PROPERTY_FRAUD_OFFSET

JSON_PROPERTY_INSTALLMENTS

JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT

JSON_PROPERTY_MCC

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_MERCHANT_ORDER_REFERENCE

JSON_PROPERTY_MERCHANT_RISK_INDICATOR

JSON_PROPERTY_METADATA

JSON_PROPERTY_ORDER_REFERENCE

JSON_PROPERTY_PAYMENT_METHOD

JSON_PROPERTY_RECURRING

JSON_PROPERTY_RECURRING_PROCESSING_MODEL

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SELECTED_BRAND

JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_SESSION_ID

JSON_PROPERTY_SHOPPER_EMAIL

JSON_PROPERTY_SHOPPER_I_P

JSON_PROPERTY_SHOPPER_INTERACTION

JSON_PROPERTY_SHOPPER_LOCALE

JSON_PROPERTY_SHOPPER_NAME

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_SHOPPER_STATEMENT

JSON_PROPERTY_SOCIAL_SECURITY_NUMBER

JSON_PROPERTY_SPLITS

JSON_PROPERTY_STORE

JSON_PROPERTY_TELEPHONE_NUMBER

JSON_PROPERTY_THREE_D_S2_REQUEST_DATA

JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY

JSON_PROPERTY_TOTALS_GROUP

JSON_PROPERTY_TRUSTED_SHOPPER

Constructor Detail

BalanceCheckRequest

Method Detail

accountInfo

getAccountInfo

setAccountInfo

additionalAmount

getAdditionalAmount

setAdditionalAmount

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

amount

getAmount

setAmount

applicationInfo

getApplicationInfo

setApplicationInfo

billingAddress

getBillingAddress

setBillingAddress

browserInfo

getBrowserInfo

setBrowserInfo

captureDelayHours

getCaptureDelayHours

setCaptureDelayHours

dateOfBirth