java.lang.Object
- com.adyen.model.configurationwebhooks.BalanceAccount

public class BalanceAccount
extends Object

BalanceAccount

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BalanceAccount.StatusEnum
The status of the balance account, set to **Active** by default.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ACCOUNT_HOLDER_ID`
`static String`	`JSON_PROPERTY_BALANCES`
`static String`	`JSON_PROPERTY_DEFAULT_CURRENCY_CODE`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_METADATA`
`static String`	`JSON_PROPERTY_PAYMENT_INSTRUMENTS`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_STATUS`
`static String`	`JSON_PROPERTY_SWEEP_CONFIGURATIONS`
`static String`	`JSON_PROPERTY_TIME_ZONE`

Constructor Summary

Constructors
Constructor Description

BalanceAccount()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BalanceAccount`	`accountHolderId(String accountHolderId)`
`BalanceAccount`	`addBalancesItem(Balance balancesItem)`
`BalanceAccount`	`addPaymentInstrumentsItem(PaymentInstrumentReference paymentInstrumentsItem)`
`BalanceAccount`	`balances(List<Balance> balances)`
`BalanceAccount`	`defaultCurrencyCode(String defaultCurrencyCode)`
`BalanceAccount`	`description(String description)`
`boolean`	`equals(Object o)`	Return true if this BalanceAccount object is equal to o.
`static BalanceAccount`	`fromJson(String jsonString)`	Create an instance of BalanceAccount given an JSON string
`String`	`getAccountHolderId()`	The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
`List<Balance>`	`getBalances()`	List of balances with the amount and currency.
`String`	`getDefaultCurrencyCode()`	The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.
`String`	`getDescription()`	A human-readable description of the balance account, maximum 300 characters.
`String`	`getId()`	The unique identifier of the balance account.
`Map<String,String>`	`getMetadata()`	A set of key and value pairs for general use by the merchant.
`List<PaymentInstrumentReference>`	`getPaymentInstruments()`	List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments) associated with the balance account.
`String`	`getReference()`	Your reference for the balance account, maximum 150 characters.
`BalanceAccount.StatusEnum`	`getStatus()`	The status of the balance account, set to Active by default.
`Map<String,SweepConfiguration>`	`getSweepConfigurations()`	Contains key-value pairs that specify configurations for balance sweeps per currency code.
`String`	`getTimeZone()`	The time zone of the balance account.
`int`	`hashCode()`
`BalanceAccount`	`id(String id)`
`BalanceAccount`	`metadata(Map<String,String> metadata)`
`BalanceAccount`	`paymentInstruments(List<PaymentInstrumentReference> paymentInstruments)`
`BalanceAccount`	`putMetadataItem(String key, String metadataItem)`
`BalanceAccount`	`putSweepConfigurationsItem(String key, SweepConfiguration sweepConfigurationsItem)`
`BalanceAccount`	`reference(String reference)`
`void`	`setAccountHolderId(String accountHolderId)`
`void`	`setBalances(List<Balance> balances)`
`void`	`setDefaultCurrencyCode(String defaultCurrencyCode)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setPaymentInstruments(List<PaymentInstrumentReference> paymentInstruments)`
`void`	`setReference(String reference)`
`void`	`setStatus(BalanceAccount.StatusEnum status)`
`void`	`setSweepConfigurations(Map<String,SweepConfiguration> sweepConfigurations)`
`void`	`setTimeZone(String timeZone)`
`BalanceAccount`	`status(BalanceAccount.StatusEnum status)`
`BalanceAccount`	`sweepConfigurations(Map<String,SweepConfiguration> sweepConfigurations)`
`BalanceAccount`	`timeZone(String timeZone)`
`String`	`toJson()`	Convert an instance of BalanceAccount 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_ACCOUNT_HOLDER_ID
```
public static final String JSON_PROPERTY_ACCOUNT_HOLDER_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BALANCES
```
public static final String JSON_PROPERTY_BALANCES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DEFAULT_CURRENCY_CODE
```
public static final String JSON_PROPERTY_DEFAULT_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_METADATA
```
public static final String JSON_PROPERTY_METADATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_INSTRUMENTS
```
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STATUS
```
public static final String JSON_PROPERTY_STATUS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SWEEP_CONFIGURATIONS
```
public static final String JSON_PROPERTY_SWEEP_CONFIGURATIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TIME_ZONE
```
public static final String JSON_PROPERTY_TIME_ZONE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BalanceAccount
```
public BalanceAccount()
```
- Method Detail
  - accountHolderId
```
public BalanceAccount accountHolderId(String accountHolderId)
```
  - getAccountHolderId
```
public String getAccountHolderId()
```
    The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
    
    Returns:
    
    accountHolderId
  - setAccountHolderId
```
public void setAccountHolderId(String accountHolderId)
```
  - balances
```
public BalanceAccount balances(List<Balance> balances)
```
  - addBalancesItem
```
public BalanceAccount addBalancesItem(Balance balancesItem)
```
  - getBalances
```
public List<Balance> getBalances()
```
    List of balances with the amount and currency.
    
    Returns:
    
    balances
  - setBalances
```
public void setBalances(List<Balance> balances)
```
  - defaultCurrencyCode
```
public BalanceAccount defaultCurrencyCode(String defaultCurrencyCode)
```
  - getDefaultCurrencyCode
```
public String getDefaultCurrencyCode()
```
    The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**.
    
    Returns:
    
    defaultCurrencyCode
  - setDefaultCurrencyCode
```
public void setDefaultCurrencyCode(String defaultCurrencyCode)
```
  - description
```
public BalanceAccount description(String description)
```
  - getDescription
```
public String getDescription()
```
    A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - id
```
public BalanceAccount id(String id)
```
  - getId
```
public String getId()
```
    The unique identifier of the balance account.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - metadata
```
public BalanceAccount metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public BalanceAccount putMetadataItem(String key,
                                      String metadataItem)
```
  - getMetadata
```
public Map<String,String> getMetadata()
```
    A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(Map<String,String> metadata)
```
  - paymentInstruments
```
public BalanceAccount paymentInstruments(List<PaymentInstrumentReference> paymentInstruments)
```
  - addPaymentInstrumentsItem
```
public BalanceAccount addPaymentInstrumentsItem(PaymentInstrumentReference paymentInstrumentsItem)
```
  - getPaymentInstruments
```
public List<PaymentInstrumentReference> getPaymentInstruments()
```
    List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments) associated with the balance account.
    
    Returns:
    
    paymentInstruments
  - setPaymentInstruments
```
public void setPaymentInstruments(List<PaymentInstrumentReference> paymentInstruments)
```
  - reference
```
public BalanceAccount reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the balance account, maximum 150 characters.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
  - status
```
public BalanceAccount status(BalanceAccount.StatusEnum status)
```
  - getStatus
```
public BalanceAccount.StatusEnum getStatus()
```
    The status of the balance account, set to **Active** by default.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(BalanceAccount.StatusEnum status)
```
  - sweepConfigurations
```
public BalanceAccount sweepConfigurations(Map<String,SweepConfiguration> sweepConfigurations)
```
  - putSweepConfigurationsItem
```
public BalanceAccount putSweepConfigurationsItem(String key,
                                                 SweepConfiguration sweepConfigurationsItem)
```
  - getSweepConfigurations
```
public Map<String,SweepConfiguration> getSweepConfigurations()
```
    Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds). The key must be a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.
    
    Returns:
    
    sweepConfigurations
  - setSweepConfigurations
```
public void setSweepConfigurations(Map<String,SweepConfiguration> sweepConfigurations)
```
  - timeZone
```
public BalanceAccount timeZone(String timeZone)
```
  - getTimeZone
```
public String getTimeZone()
```
    The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
    
    Returns:
    
    timeZone
  - setTimeZone
```
public void setTimeZone(String timeZone)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this BalanceAccount 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 BalanceAccount fromJson(String jsonString)
                               throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of BalanceAccount given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of BalanceAccount
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to BalanceAccount
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of BalanceAccount to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class BalanceAccount

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACCOUNT_HOLDER_ID

JSON_PROPERTY_BALANCES

JSON_PROPERTY_DEFAULT_CURRENCY_CODE

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_ID

JSON_PROPERTY_METADATA

JSON_PROPERTY_PAYMENT_INSTRUMENTS

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_STATUS

JSON_PROPERTY_SWEEP_CONFIGURATIONS

JSON_PROPERTY_TIME_ZONE

Constructor Detail

BalanceAccount

Method Detail

accountHolderId

getAccountHolderId

setAccountHolderId

balances

addBalancesItem

getBalances

setBalances

defaultCurrencyCode

getDefaultCurrencyCode

setDefaultCurrencyCode

description

getDescription

setDescription

id

getId

setId

metadata

putMetadataItem

getMetadata

setMetadata

paymentInstruments

addPaymentInstrumentsItem

getPaymentInstruments

setPaymentInstruments

reference

getReference

setReference

status

getStatus

setStatus

sweepConfigurations

putSweepConfigurationsItem

getSweepConfigurations

setSweepConfigurations

timeZone

getTimeZone

setTimeZone

equals

hashCode

toString

fromJson

toJson