Package com.adyen.model.balanceplatform

Class BalanceAccountBase

  • public class BalanceAccountBase
extends Object
    BalanceAccountBase

    • Constructor Detail

      • BalanceAccountBase

        public BalanceAccountBase()

      • BalanceAccountBase

        public BalanceAccountBase​(String migratedAccountCode)

    • Method Detail

      • accountHolderId

        public BalanceAccountBase accountHolderId​(String accountHolderId)
        The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.
        Parameters:
        accountHolderId - The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.
        Returns:
        the current BalanceAccountBase instance, allowing for method chaining

      • getAccountHolderId

        public String getAccountHolderId()
        The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.
        Returns:
        accountHolderId The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.

      • setAccountHolderId

        public void setAccountHolderId​(String accountHolderId)
        The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.
        Parameters:
        accountHolderId - The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.

      • defaultCurrencyCode

        public BalanceAccountBase defaultCurrencyCode​(String defaultCurrencyCode)
        The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Parameters:
        defaultCurrencyCode - The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Returns:
        the current BalanceAccountBase instance, allowing for method chaining

      • getDefaultCurrencyCode

        public String getDefaultCurrencyCode()
        The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Returns:
        defaultCurrencyCode The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.

      • 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. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Parameters:
        defaultCurrencyCode - The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.

      • description

        public BalanceAccountBase description​(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 - 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:
        the current BalanceAccountBase instance, allowing for method chaining

      • 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 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.

      • 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 - 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.

      • id

        public BalanceAccountBase id​(String id)
        The unique identifier of the balance account.
        Parameters:
        id - The unique identifier of the balance account.
        Returns:
        the current BalanceAccountBase instance, allowing for method chaining

      • getId

        public String getId()
        The unique identifier of the balance account.
        Returns:
        id The unique identifier of the balance account.

      • setId

        public void setId​(String id)
        The unique identifier of the balance account.
        Parameters:
        id - The unique identifier of the balance account.

      • metadata

        public BalanceAccountBase metadata​(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 - 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:
        the current BalanceAccountBase instance, allowing for method chaining

      • 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 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.

      • 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 - 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.

      • getMigratedAccountCode

        public String getMigratedAccountCode()
        The unique identifier of the account of the migrated account holder in the classic integration.
        Returns:
        migratedAccountCode The unique identifier of the account of the migrated account holder in the classic integration.

      • platformPaymentConfiguration

        public BalanceAccountBase platformPaymentConfiguration​(PlatformPaymentConfiguration platformPaymentConfiguration)
        platformPaymentConfiguration
        Parameters:
        platformPaymentConfiguration -
        Returns:
        the current BalanceAccountBase instance, allowing for method chaining

      • getPlatformPaymentConfiguration

        public PlatformPaymentConfiguration getPlatformPaymentConfiguration()
        Get platformPaymentConfiguration
        Returns:
        platformPaymentConfiguration

      • setPlatformPaymentConfiguration

        public void setPlatformPaymentConfiguration​(PlatformPaymentConfiguration platformPaymentConfiguration)
        platformPaymentConfiguration
        Parameters:
        platformPaymentConfiguration -

      • reference

        public BalanceAccountBase reference​(String reference)
        Your reference for the balance account, maximum 150 characters.
        Parameters:
        reference - Your reference for the balance account, maximum 150 characters.
        Returns:
        the current BalanceAccountBase instance, allowing for method chaining

      • getReference

        public String getReference()
        Your reference for the balance account, maximum 150 characters.
        Returns:
        reference Your reference for the balance account, maximum 150 characters.

      • setReference

        public void setReference​(String reference)
        Your reference for the balance account, maximum 150 characters.
        Parameters:
        reference - Your reference for the balance account, maximum 150 characters.

      • status

        public BalanceAccountBase status​(BalanceAccountBase.StatusEnum status)
        The status of the balance account, set to **active** by default.
        Parameters:
        status - The status of the balance account, set to **active** by default.
        Returns:
        the current BalanceAccountBase instance, allowing for method chaining

      • getStatus

        public BalanceAccountBase.StatusEnum getStatus()
        The status of the balance account, set to **active** by default.
        Returns:
        status The status of the balance account, set to **active** by default.

      • setStatus

        public void setStatus​(BalanceAccountBase.StatusEnum status)
        The status of the balance account, set to **active** by default.
        Parameters:
        status - The status of the balance account, set to **active** by default.

      • timeZone

        public BalanceAccountBase timeZone​(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 - 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:
        the current BalanceAccountBase instance, allowing for method chaining

      • 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 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).

      • 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 - 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).

      • includeNullValues

        public BalanceAccountBase includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this BalanceAccountBase object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • 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