Package com.adyen.model.balanceplatform
Class BalanceAccountBase
- java.lang.Object
-
- com.adyen.model.balanceplatform.BalanceAccountBase
-
public class BalanceAccountBase extends Object
BalanceAccountBase
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBalanceAccountBase.CustomTypeAdapterFactorystatic classBalanceAccountBase.StatusEnumThe status of the balance account, set to **active** by default.
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_ACCOUNT_HOLDER_IDstatic StringSERIALIZED_NAME_DEFAULT_CURRENCY_CODEstatic StringSERIALIZED_NAME_DESCRIPTIONstatic StringSERIALIZED_NAME_IDstatic StringSERIALIZED_NAME_METADATAstatic StringSERIALIZED_NAME_REFERENCEstatic StringSERIALIZED_NAME_STATUSstatic StringSERIALIZED_NAME_TIME_ZONE
-
Constructor Summary
Constructors Constructor Description BalanceAccountBase()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BalanceAccountBaseaccountHolderId(String accountHolderId)BalanceAccountBasedefaultCurrencyCode(String defaultCurrencyCode)BalanceAccountBasedescription(String description)booleanequals(Object o)static BalanceAccountBasefromJson(String jsonString)Create an instance of BalanceAccountBase given an JSON stringStringgetAccountHolderId()The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.StringgetDefaultCurrencyCode()The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.StringgetDescription()A human-readable description of the balance account, maximum 300 characters.StringgetId()The unique identifier of the balance account.Map<String,String>getMetadata()A set of key and value pairs for general use by the merchant.StringgetReference()Your reference for the balance account, maximum 150 characters.BalanceAccountBase.StatusEnumgetStatus()The status of the balance account, set to **active** by default.StringgetTimeZone()The time zone of the balance account.inthashCode()BalanceAccountBaseid(String id)BalanceAccountBasemetadata(Map<String,String> metadata)BalanceAccountBaseputMetadataItem(String key, String metadataItem)BalanceAccountBasereference(String reference)voidsetAccountHolderId(String accountHolderId)voidsetDefaultCurrencyCode(String defaultCurrencyCode)voidsetDescription(String description)voidsetId(String id)voidsetMetadata(Map<String,String> metadata)voidsetReference(String reference)voidsetStatus(BalanceAccountBase.StatusEnum status)voidsetTimeZone(String timeZone)BalanceAccountBasestatus(BalanceAccountBase.StatusEnum status)BalanceAccountBasetimeZone(String timeZone)StringtoJson()Convert an instance of BalanceAccountBase to an JSON stringStringtoString()static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj)Validates the JSON Object and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_ACCOUNT_HOLDER_ID
public static final String SERIALIZED_NAME_ACCOUNT_HOLDER_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DEFAULT_CURRENCY_CODE
public static final String SERIALIZED_NAME_DEFAULT_CURRENCY_CODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DESCRIPTION
public static final String SERIALIZED_NAME_DESCRIPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_METADATA
public static final String SERIALIZED_NAME_METADATA
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REFERENCE
public static final String SERIALIZED_NAME_REFERENCE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_STATUS
public static final String SERIALIZED_NAME_STATUS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TIME_ZONE
public static final String SERIALIZED_NAME_TIME_ZONE
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountHolderId
public BalanceAccountBase 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)
-
defaultCurrencyCode
public BalanceAccountBase 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 BalanceAccountBase 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 BalanceAccountBase id(String id)
-
getId
public String getId()
The unique identifier of the balance account.- Returns:
- id
-
setId
public void setId(String id)
-
metadata
public BalanceAccountBase metadata(Map<String,String> metadata)
-
putMetadataItem
public BalanceAccountBase 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
-
reference
public BalanceAccountBase 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 BalanceAccountBase status(BalanceAccountBase.StatusEnum status)
-
getStatus
public BalanceAccountBase.StatusEnum getStatus()
The status of the balance account, set to **active** by default.- Returns:
- status
-
setStatus
public void setStatus(BalanceAccountBase.StatusEnum status)
-
timeZone
public BalanceAccountBase 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)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOExceptionValidates the JSON Object and throws an exception if issues found- Parameters:
jsonObj- JSON Object- Throws:
IOException- if the JSON Object is invalid with respect to BalanceAccountBase
-
fromJson
public static BalanceAccountBase fromJson(String jsonString) throws IOException
Create an instance of BalanceAccountBase given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of BalanceAccountBase
- Throws:
IOException- if the JSON string is invalid with respect to BalanceAccountBase
-
toJson
public String toJson()
Convert an instance of BalanceAccountBase to an JSON string- Returns:
- JSON string
-
-