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

public class AccountHolder
extends Object

AccountHolder

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AccountHolder.StatusEnum
The status of the account holder.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BALANCE_PLATFORM`
`static String`	`JSON_PROPERTY_CAPABILITIES`
`static String`	`JSON_PROPERTY_CONTACT_DETAILS`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_LEGAL_ENTITY_ID`
`static String`	`JSON_PROPERTY_METADATA`
`static String`	`JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE`
`static String`	`JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_STATUS`
`static String`	`JSON_PROPERTY_TIME_ZONE`

Constructor Summary

Constructors
Constructor Description

AccountHolder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccountHolder`	`balancePlatform(String balancePlatform)`
`AccountHolder`	`capabilities(Map<String,AccountHolderCapability> capabilities)`
`AccountHolder`	`contactDetails(ContactDetails contactDetails)`
`AccountHolder`	`description(String description)`
`boolean`	`equals(Object o)`	Return true if this AccountHolder object is equal to o.
`static AccountHolder`	`fromJson(String jsonString)`	Create an instance of AccountHolder given an JSON string
`String`	`getBalancePlatform()`	The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs.
`Map<String,AccountHolderCapability>`	`getCapabilities()`	Contains key-value pairs that specify the actions that an account holder can do in your platform.
`ContactDetails`	`getContactDetails()`	Get contactDetails
`String`	`getDescription()`	Your description for the account holder, maximum 300 characters.
`String`	`getId()`	The unique identifier of the account holder.
`String`	`getLegalEntityId()`	The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder.
`Map<String,String>`	`getMetadata()`	A set of key and value pairs for general use.
`String`	`getMigratedAccountHolderCode()`	The unique identifier of the migrated account holder in the classic integration.
`String`	`getPrimaryBalanceAccount()`	The ID of the account holder's primary balance account.
`String`	`getReference()`	Your reference for the account holder, maximum 150 characters.
`AccountHolder.StatusEnum`	`getStatus()`	The status of the account holder.
`String`	`getTimeZone()`	The time zone of the account holder.
`int`	`hashCode()`
`AccountHolder`	`id(String id)`
`AccountHolder`	`legalEntityId(String legalEntityId)`
`AccountHolder`	`metadata(Map<String,String> metadata)`
`AccountHolder`	`migratedAccountHolderCode(String migratedAccountHolderCode)`
`AccountHolder`	`primaryBalanceAccount(String primaryBalanceAccount)`
`AccountHolder`	`putCapabilitiesItem(String key, AccountHolderCapability capabilitiesItem)`
`AccountHolder`	`putMetadataItem(String key, String metadataItem)`
`AccountHolder`	`reference(String reference)`
`void`	`setBalancePlatform(String balancePlatform)`
`void`	`setCapabilities(Map<String,AccountHolderCapability> capabilities)`
`void`	`setContactDetails(ContactDetails contactDetails)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setLegalEntityId(String legalEntityId)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setMigratedAccountHolderCode(String migratedAccountHolderCode)`
`void`	`setPrimaryBalanceAccount(String primaryBalanceAccount)`
`void`	`setReference(String reference)`
`void`	`setStatus(AccountHolder.StatusEnum status)`
`void`	`setTimeZone(String timeZone)`
`AccountHolder`	`status(AccountHolder.StatusEnum status)`
`AccountHolder`	`timeZone(String timeZone)`
`String`	`toJson()`	Convert an instance of AccountHolder 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_BALANCE_PLATFORM
```
public static final String JSON_PROPERTY_BALANCE_PLATFORM
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAPABILITIES
```
public static final String JSON_PROPERTY_CAPABILITIES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CONTACT_DETAILS
```
public static final String JSON_PROPERTY_CONTACT_DETAILS
```
    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_LEGAL_ENTITY_ID
```
public static final String JSON_PROPERTY_LEGAL_ENTITY_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_HOLDER_CODE
```
public static final String JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT
```
public static final String JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT
```
    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
- Constructor Detail
  - AccountHolder
```
public AccountHolder()
```
- Method Detail
  - balancePlatform
```
public AccountHolder balancePlatform(String balancePlatform)
```
  - getBalancePlatform
```
public String getBalancePlatform()
```
    The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
    
    Returns:
    
    balancePlatform
  - setBalancePlatform
```
public void setBalancePlatform(String balancePlatform)
```
  - capabilities
```
public AccountHolder capabilities(Map<String,AccountHolderCapability> capabilities)
```
  - putCapabilitiesItem
```
public AccountHolder putCapabilitiesItem(String key,
                                         AccountHolderCapability capabilitiesItem)
```
  - getCapabilities
```
public Map<String,AccountHolderCapability> getCapabilities()
```
    Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
    
    Returns:
    
    capabilities
  - setCapabilities
```
public void setCapabilities(Map<String,AccountHolderCapability> capabilities)
```
  - contactDetails
```
public AccountHolder contactDetails(ContactDetails contactDetails)
```
  - getContactDetails
```
public ContactDetails getContactDetails()
```
    Get contactDetails
    
    Returns:
    
    contactDetails
  - setContactDetails
```
public void setContactDetails(ContactDetails contactDetails)
```
  - description
```
public AccountHolder description(String description)
```
  - getDescription
```
public String getDescription()
```
    Your description for the account holder, maximum 300 characters.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - id
```
public AccountHolder id(String id)
```
  - getId
```
public String getId()
```
    The unique identifier of the account holder.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - legalEntityId
```
public AccountHolder legalEntityId(String legalEntityId)
```
  - getLegalEntityId
```
public String getLegalEntityId()
```
    The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
    
    Returns:
    
    legalEntityId
  - setLegalEntityId
```
public void setLegalEntityId(String legalEntityId)
```
  - metadata
```
public AccountHolder metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public AccountHolder 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)
```
  - migratedAccountHolderCode
```
public AccountHolder migratedAccountHolderCode(String migratedAccountHolderCode)
```
  - getMigratedAccountHolderCode
```
public String getMigratedAccountHolderCode()
```
    The unique identifier of the migrated account holder in the classic integration.
    
    Returns:
    
    migratedAccountHolderCode
  - setMigratedAccountHolderCode
```
public void setMigratedAccountHolderCode(String migratedAccountHolderCode)
```
  - primaryBalanceAccount
```
public AccountHolder primaryBalanceAccount(String primaryBalanceAccount)
```
  - getPrimaryBalanceAccount
```
public String getPrimaryBalanceAccount()
```
    The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
    
    Returns:
    
    primaryBalanceAccount
  - setPrimaryBalanceAccount
```
public void setPrimaryBalanceAccount(String primaryBalanceAccount)
```
  - reference
```
public AccountHolder reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the account holder, maximum 150 characters.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
  - status
```
public AccountHolder status(AccountHolder.StatusEnum status)
```
  - getStatus
```
public AccountHolder.StatusEnum getStatus()
```
    The status of the account holder. Possible values: * **Active**: The account holder is active. This is the default status when creating an account holder. * **Inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. * **Suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. * **Closed**: The account holder is permanently deactivated by you. This action cannot be undone.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(AccountHolder.StatusEnum status)
```
  - timeZone
```
public AccountHolder timeZone(String timeZone)
```
  - getTimeZone
```
public String getTimeZone()
```
    The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform 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 AccountHolder 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 AccountHolder fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of AccountHolder given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of AccountHolder
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to AccountHolder
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of AccountHolder to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class AccountHolder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BALANCE_PLATFORM

JSON_PROPERTY_CAPABILITIES

JSON_PROPERTY_CONTACT_DETAILS

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_ID

JSON_PROPERTY_LEGAL_ENTITY_ID

JSON_PROPERTY_METADATA

JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE

JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_STATUS

JSON_PROPERTY_TIME_ZONE

Constructor Detail

AccountHolder

Method Detail

balancePlatform

getBalancePlatform

setBalancePlatform

capabilities

putCapabilitiesItem

getCapabilities

setCapabilities

contactDetails

getContactDetails

setContactDetails

description

getDescription

setDescription

id

getId

setId

legalEntityId

getLegalEntityId

setLegalEntityId

metadata

putMetadataItem

getMetadata

setMetadata

migratedAccountHolderCode

getMigratedAccountHolderCode

setMigratedAccountHolderCode

primaryBalanceAccount

getPrimaryBalanceAccount

setPrimaryBalanceAccount

reference

getReference

setReference

status

getStatus

setStatus

timeZone

getTimeZone

setTimeZone

equals

hashCode

toString

fromJson

toJson