java.lang.Object
- com.adyen.model.balanceplatform.AccountHolderUpdateRequest

public class AccountHolderUpdateRequest
extends Object

AccountHolderUpdateRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AccountHolderUpdateRequest.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_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`
`static String`	`JSON_PROPERTY_VERIFICATION_DEADLINES`

Constructor Summary

Constructors
Constructor Description

AccountHolderUpdateRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`AccountHolderUpdateRequest`	`addVerificationDeadlinesItem(VerificationDeadline verificationDeadlinesItem)`
`AccountHolderUpdateRequest`	`balancePlatform(String balancePlatform)`
`AccountHolderUpdateRequest`	`capabilities(Map<String,AccountHolderCapability> capabilities)`
`AccountHolderUpdateRequest`	`contactDetails(ContactDetails contactDetails)`	Deprecated.
`AccountHolderUpdateRequest`	`description(String description)`
`boolean`	`equals(Object o)`	Return true if this AccountHolderUpdateRequest object is equal to o.
`static AccountHolderUpdateRequest`	`fromJson(String jsonString)`	Create an instance of AccountHolderUpdateRequest 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()`	Deprecated.
`String`	`getDescription()`	Your description for 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.
`AccountHolderUpdateRequest.StatusEnum`	`getStatus()`	The status of the account holder.
`String`	`getTimeZone()`	The time zone of the account holder.
`List<VerificationDeadline>`	`getVerificationDeadlines()`	List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
`int`	`hashCode()`
`AccountHolderUpdateRequest`	`metadata(Map<String,String> metadata)`
`AccountHolderUpdateRequest`	`migratedAccountHolderCode(String migratedAccountHolderCode)`
`AccountHolderUpdateRequest`	`primaryBalanceAccount(String primaryBalanceAccount)`
`AccountHolderUpdateRequest`	`putCapabilitiesItem(String key, AccountHolderCapability capabilitiesItem)`
`AccountHolderUpdateRequest`	`putMetadataItem(String key, String metadataItem)`
`AccountHolderUpdateRequest`	`reference(String reference)`
`void`	`setBalancePlatform(String balancePlatform)`	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.
`void`	`setCapabilities(Map<String,AccountHolderCapability> capabilities)`	Contains key-value pairs that specify the actions that an account holder can do in your platform.
`void`	`setContactDetails(ContactDetails contactDetails)`	Deprecated.
`void`	`setDescription(String description)`	Your description for the account holder.
`void`	`setMetadata(Map<String,String> metadata)`	A set of key and value pairs for general use.
`void`	`setMigratedAccountHolderCode(String migratedAccountHolderCode)`	The unique identifier of the migrated account holder in the classic integration.
`void`	`setPrimaryBalanceAccount(String primaryBalanceAccount)`	The ID of the account holder's primary balance account.
`void`	`setReference(String reference)`	Your reference for the account holder.
`void`	`setStatus(AccountHolderUpdateRequest.StatusEnum status)`	The status of the account holder.
`void`	`setTimeZone(String timeZone)`	The time zone of the account holder.
`void`	`setVerificationDeadlines(List<VerificationDeadline> verificationDeadlines)`	List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
`AccountHolderUpdateRequest`	`status(AccountHolderUpdateRequest.StatusEnum status)`
`AccountHolderUpdateRequest`	`timeZone(String timeZone)`
`String`	`toJson()`	Convert an instance of AccountHolderUpdateRequest to an JSON string
`String`	`toString()`
`AccountHolderUpdateRequest`	`verificationDeadlines(List<VerificationDeadline> verificationDeadlines)`

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_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
  - JSON_PROPERTY_VERIFICATION_DEADLINES
```
public static final String JSON_PROPERTY_VERIFICATION_DEADLINES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AccountHolderUpdateRequest
```
public AccountHolderUpdateRequest()
```
- Method Detail
  - balancePlatform
```
public AccountHolderUpdateRequest 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)
```
    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.
    
    Parameters:
    
    balancePlatform -
  - capabilities
```
public AccountHolderUpdateRequest capabilities(Map<String,AccountHolderCapability> capabilities)
```
  - putCapabilitiesItem
```
public AccountHolderUpdateRequest 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)
```
    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.
    
    Parameters:
    
    capabilities -
  - contactDetails
```
@Deprecated
public AccountHolderUpdateRequest contactDetails(ContactDetails contactDetails)
```
    Deprecated.
  - getContactDetails
```
@Deprecated
public ContactDetails getContactDetails()
```
    Deprecated.
    
    Get contactDetails
    
    Returns:
    
    contactDetails
  - setContactDetails
```
@Deprecated
public void setContactDetails(ContactDetails contactDetails)
```
    Deprecated.
    
    contactDetails
    
    Parameters:
    
    contactDetails -
  - description
```
public AccountHolderUpdateRequest description(String description)
```
  - getDescription
```
public String getDescription()
```
    Your description for the account holder.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
    Your description for the account holder.
    
    Parameters:
    
    description -
  - metadata
```
public AccountHolderUpdateRequest metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public AccountHolderUpdateRequest 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 -
  - migratedAccountHolderCode
```
public AccountHolderUpdateRequest 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)
```
    The unique identifier of the migrated account holder in the classic integration.
    
    Parameters:
    
    migratedAccountHolderCode -
  - primaryBalanceAccount
```
public AccountHolderUpdateRequest 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)
```
    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.
    
    Parameters:
    
    primaryBalanceAccount -
  - reference
```
public AccountHolderUpdateRequest reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the account holder.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    Your reference for the account holder.
    
    Parameters:
    
    reference -
  - status
```
public AccountHolderUpdateRequest status(AccountHolderUpdateRequest.StatusEnum status)
```
  - getStatus
```
public AccountHolderUpdateRequest.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. * **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(AccountHolderUpdateRequest.StatusEnum status)
```
    The status of the account holder. Possible values: * **active**: The account holder is active. This is the default status when creating an account holder. * **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.
    
    Parameters:
    
    status -
  - timeZone
```
public AccountHolderUpdateRequest 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)
```
    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).
    
    Parameters:
    
    timeZone -
  - verificationDeadlines
```
public AccountHolderUpdateRequest verificationDeadlines(List<VerificationDeadline> verificationDeadlines)
```
  - addVerificationDeadlinesItem
```
public AccountHolderUpdateRequest addVerificationDeadlinesItem(VerificationDeadline verificationDeadlinesItem)
```
  - getVerificationDeadlines
```
public List<VerificationDeadline> getVerificationDeadlines()
```
    List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
    
    Returns:
    
    verificationDeadlines
  - setVerificationDeadlines
```
public void setVerificationDeadlines(List<VerificationDeadline> verificationDeadlines)
```
    List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
    
    Parameters:
    
    verificationDeadlines -
  - equals
```
public boolean equals(Object o)
```
    Return true if this AccountHolderUpdateRequest 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 AccountHolderUpdateRequest fromJson(String jsonString)
                                           throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of AccountHolderUpdateRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of AccountHolderUpdateRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to AccountHolderUpdateRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of AccountHolderUpdateRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class AccountHolderUpdateRequest

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_METADATA

JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE

JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_STATUS

JSON_PROPERTY_TIME_ZONE

JSON_PROPERTY_VERIFICATION_DEADLINES

Constructor Detail

AccountHolderUpdateRequest

Method Detail

balancePlatform

getBalancePlatform

setBalancePlatform

capabilities

putCapabilitiesItem

getCapabilities

setCapabilities

contactDetails

getContactDetails

setContactDetails

description

getDescription

setDescription

metadata

putMetadataItem

getMetadata

setMetadata

migratedAccountHolderCode

getMigratedAccountHolderCode

setMigratedAccountHolderCode

primaryBalanceAccount

getPrimaryBalanceAccount

setPrimaryBalanceAccount

reference

getReference

setReference

status

getStatus

setStatus

timeZone

getTimeZone

setTimeZone

verificationDeadlines

addVerificationDeadlinesItem

getVerificationDeadlines

setVerificationDeadlines

equals

hashCode

toString

fromJson

toJson