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.StatusEnumThe status of the balance account, set to **active** by default.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACCOUNT_HOLDER_IDstatic StringJSON_PROPERTY_DEFAULT_CURRENCY_CODEstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_METADATAstatic StringJSON_PROPERTY_MIGRATED_ACCOUNT_CODEstatic StringJSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATIONstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_STATUSstatic StringJSON_PROPERTY_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)Return true if this BalanceAccountBase object is equal to 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.StringgetMigratedAccountCode()The unique identifier of the account of the migrated account holder in the classic integration.PlatformPaymentConfigurationgetPlatformPaymentConfiguration()Get platformPaymentConfigurationStringgetReference()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)BalanceAccountBasemigratedAccountCode(String migratedAccountCode)BalanceAccountBaseplatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration)BalanceAccountBaseputMetadataItem(String key, String metadataItem)BalanceAccountBasereference(String reference)voidsetAccountHolderId(String accountHolderId)The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.voidsetDefaultCurrencyCode(String defaultCurrencyCode)The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.voidsetDescription(String description)A human-readable description of the balance account, maximum 300 characters.voidsetId(String id)The unique identifier of the balance account.voidsetMetadata(Map<String,String> metadata)A set of key and value pairs for general use.voidsetMigratedAccountCode(String migratedAccountCode)The unique identifier of the account of the migrated account holder in the classic integration.voidsetPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration)platformPaymentConfigurationvoidsetReference(String reference)Your reference for the balance account, maximum 150 characters.voidsetStatus(BalanceAccountBase.StatusEnum status)The status of the balance account, set to **active** by default.voidsetTimeZone(String timeZone)The time zone of the balance account.BalanceAccountBasestatus(BalanceAccountBase.StatusEnum status)BalanceAccountBasetimeZone(String timeZone)StringtoJson()Convert an instance of BalanceAccountBase to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_HOLDER_ID
public static final String JSON_PROPERTY_ACCOUNT_HOLDER_ID
- 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_MIGRATED_ACCOUNT_CODE
public static final String JSON_PROPERTY_MIGRATED_ACCOUNT_CODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION
public static final String JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION
- 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_TIME_ZONE
public static final String JSON_PROPERTY_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)
The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.- Parameters:
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**. > After a balance account is created, you cannot change its default currency.- Returns:
- defaultCurrencyCode
-
setDefaultCurrencyCode
public void setDefaultCurrencyCode(String defaultCurrencyCode)
The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.- Parameters:
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)
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.- Parameters:
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)
The unique identifier of the balance account.- Parameters:
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. 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)
A set of key and value pairs for general use. 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.- Parameters:
metadata-
-
migratedAccountCode
public BalanceAccountBase migratedAccountCode(String migratedAccountCode)
-
getMigratedAccountCode
public String getMigratedAccountCode()
The unique identifier of the account of the migrated account holder in the classic integration.- Returns:
- migratedAccountCode
-
setMigratedAccountCode
public void setMigratedAccountCode(String migratedAccountCode)
The unique identifier of the account of the migrated account holder in the classic integration.- Parameters:
migratedAccountCode-
-
platformPaymentConfiguration
public BalanceAccountBase platformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration)
-
getPlatformPaymentConfiguration
public PlatformPaymentConfiguration getPlatformPaymentConfiguration()
Get platformPaymentConfiguration- Returns:
- platformPaymentConfiguration
-
setPlatformPaymentConfiguration
public void setPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration)
platformPaymentConfiguration- Parameters:
platformPaymentConfiguration-
-
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)
Your reference for the balance account, maximum 150 characters.- Parameters:
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)
The status of the balance account, set to **active** by default.- Parameters:
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)
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).- Parameters:
timeZone-
-
equals
public boolean equals(Object o)
Return true if this BalanceAccountBase object is equal to o.
-
fromJson
public static BalanceAccountBase fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of BalanceAccountBase given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of BalanceAccountBase
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to BalanceAccountBase
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of BalanceAccountBase to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-