Package com.adyen.model.balanceplatform
Class AccountHolderCapability
- java.lang.Object
-
- com.adyen.model.balanceplatform.AccountHolderCapability
-
public class AccountHolderCapability extends Object
AccountHolderCapability
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAccountHolderCapability.AllowedLevelEnumThe capability level that is allowed for the account holder.static classAccountHolderCapability.RequestedLevelEnumThe requested level of the capability.static classAccountHolderCapability.VerificationStatusEnumThe status of the verification checks for the capability.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ALLOWEDstatic StringJSON_PROPERTY_ALLOWED_LEVELstatic StringJSON_PROPERTY_ALLOWED_SETTINGSstatic StringJSON_PROPERTY_ENABLEDstatic StringJSON_PROPERTY_PROBLEMSstatic StringJSON_PROPERTY_REQUESTEDstatic StringJSON_PROPERTY_REQUESTED_LEVELstatic StringJSON_PROPERTY_REQUESTED_SETTINGSstatic StringJSON_PROPERTY_TRANSFER_INSTRUMENTSstatic StringJSON_PROPERTY_VERIFICATION_STATUS
-
Constructor Summary
Constructors Constructor Description AccountHolderCapability()AccountHolderCapability(Boolean allowed, AccountHolderCapability.AllowedLevelEnum allowedLevel, List<CapabilityProblem> problems, List<AccountSupportingEntityCapability> transferInstruments, AccountHolderCapability.VerificationStatusEnum verificationStatus)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AccountHolderCapabilityallowedSettings(CapabilitySettings allowedSettings)allowedSettingsAccountHolderCapabilityenabled(Boolean enabled)Indicates whether the capability is enabled.booleanequals(Object o)Return true if this AccountHolderCapability object is equal to o.static AccountHolderCapabilityfromJson(String jsonString)Create an instance of AccountHolderCapability given an JSON stringBooleangetAllowed()Indicates whether the capability is allowed.AccountHolderCapability.AllowedLevelEnumgetAllowedLevel()The capability level that is allowed for the account holder.CapabilitySettingsgetAllowedSettings()Get allowedSettingsBooleangetEnabled()Indicates whether the capability is enabled.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.List<CapabilityProblem>getProblems()Contains verification errors and the actions that you can take to resolve them.BooleangetRequested()Indicates whether the capability is requested.AccountHolderCapability.RequestedLevelEnumgetRequestedLevel()The requested level of the capability.CapabilitySettingsgetRequestedSettings()Get requestedSettingsList<AccountSupportingEntityCapability>getTransferInstruments()Contains the status of the transfer instruments associated with this capability.AccountHolderCapability.VerificationStatusEnumgetVerificationStatus()The status of the verification checks for the capability.inthashCode()AccountHolderCapabilityincludeNullValues(boolean includeNullValues)Configures whether null values are explicitly serialized in the JSON payload.booleanisIncludeNullValues()Returns whether null values are explicitly serialized in the JSON payload.AccountHolderCapabilityrequested(Boolean requested)Indicates whether the capability is requested.AccountHolderCapabilityrequestedLevel(AccountHolderCapability.RequestedLevelEnum requestedLevel)The requested level of the capability.AccountHolderCapabilityrequestedSettings(CapabilitySettings requestedSettings)requestedSettingsvoidsetAllowedSettings(CapabilitySettings allowedSettings)allowedSettingsvoidsetEnabled(Boolean enabled)Indicates whether the capability is enabled.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetRequested(Boolean requested)Indicates whether the capability is requested.voidsetRequestedLevel(AccountHolderCapability.RequestedLevelEnum requestedLevel)The requested level of the capability.voidsetRequestedSettings(CapabilitySettings requestedSettings)requestedSettingsStringtoJson()Convert an instance of AccountHolderCapability to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ALLOWED
public static final String JSON_PROPERTY_ALLOWED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALLOWED_LEVEL
public static final String JSON_PROPERTY_ALLOWED_LEVEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALLOWED_SETTINGS
public static final String JSON_PROPERTY_ALLOWED_SETTINGS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLED
public static final String JSON_PROPERTY_ENABLED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PROBLEMS
public static final String JSON_PROPERTY_PROBLEMS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REQUESTED
public static final String JSON_PROPERTY_REQUESTED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REQUESTED_LEVEL
public static final String JSON_PROPERTY_REQUESTED_LEVEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REQUESTED_SETTINGS
public static final String JSON_PROPERTY_REQUESTED_SETTINGS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANSFER_INSTRUMENTS
public static final String JSON_PROPERTY_TRANSFER_INSTRUMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VERIFICATION_STATUS
public static final String JSON_PROPERTY_VERIFICATION_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AccountHolderCapability
public AccountHolderCapability()
-
AccountHolderCapability
public AccountHolderCapability(Boolean allowed, AccountHolderCapability.AllowedLevelEnum allowedLevel, List<CapabilityProblem> problems, List<AccountSupportingEntityCapability> transferInstruments, AccountHolderCapability.VerificationStatusEnum verificationStatus)
-
-
Method Detail
-
getAllowed
public Boolean getAllowed()
Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.- Returns:
- allowed Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.
-
getAllowedLevel
public AccountHolderCapability.AllowedLevelEnum getAllowedLevel()
The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**.- Returns:
- allowedLevel The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**.
-
allowedSettings
public AccountHolderCapability allowedSettings(CapabilitySettings allowedSettings)
allowedSettings- Parameters:
allowedSettings-- Returns:
- the current
AccountHolderCapabilityinstance, allowing for method chaining
-
getAllowedSettings
public CapabilitySettings getAllowedSettings()
Get allowedSettings- Returns:
- allowedSettings
-
setAllowedSettings
public void setAllowedSettings(CapabilitySettings allowedSettings)
allowedSettings- Parameters:
allowedSettings-
-
enabled
public AccountHolderCapability enabled(Boolean enabled)
Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.- Parameters:
enabled- Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.- Returns:
- the current
AccountHolderCapabilityinstance, allowing for method chaining
-
getEnabled
public Boolean getEnabled()
Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.- Returns:
- enabled Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.
-
setEnabled
public void setEnabled(Boolean enabled)
Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.- Parameters:
enabled- Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.
-
getProblems
public List<CapabilityProblem> getProblems()
Contains verification errors and the actions that you can take to resolve them.- Returns:
- problems Contains verification errors and the actions that you can take to resolve them.
-
requested
public AccountHolderCapability requested(Boolean requested)
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.- Parameters:
requested- Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.- Returns:
- the current
AccountHolderCapabilityinstance, allowing for method chaining
-
getRequested
public Boolean getRequested()
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.- Returns:
- requested Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.
-
setRequested
public void setRequested(Boolean requested)
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.- Parameters:
requested- Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.
-
requestedLevel
public AccountHolderCapability requestedLevel(AccountHolderCapability.RequestedLevelEnum requestedLevel)
The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**.- Parameters:
requestedLevel- The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**.- Returns:
- the current
AccountHolderCapabilityinstance, allowing for method chaining
-
getRequestedLevel
public AccountHolderCapability.RequestedLevelEnum getRequestedLevel()
The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**.- Returns:
- requestedLevel The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**.
-
setRequestedLevel
public void setRequestedLevel(AccountHolderCapability.RequestedLevelEnum requestedLevel)
The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**.- Parameters:
requestedLevel- The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**.
-
requestedSettings
public AccountHolderCapability requestedSettings(CapabilitySettings requestedSettings)
requestedSettings- Parameters:
requestedSettings-- Returns:
- the current
AccountHolderCapabilityinstance, allowing for method chaining
-
getRequestedSettings
public CapabilitySettings getRequestedSettings()
Get requestedSettings- Returns:
- requestedSettings
-
setRequestedSettings
public void setRequestedSettings(CapabilitySettings requestedSettings)
requestedSettings- Parameters:
requestedSettings-
-
getTransferInstruments
public List<AccountSupportingEntityCapability> getTransferInstruments()
Contains the status of the transfer instruments associated with this capability.- Returns:
- transferInstruments Contains the status of the transfer instruments associated with this capability.
-
getVerificationStatus
public AccountHolderCapability.VerificationStatusEnum getVerificationStatus()
The status of the verification checks for the capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability.- Returns:
- verificationStatus The status of the verification checks for the capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability.
-
includeNullValues
public AccountHolderCapability 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 AccountHolderCapability object is equal to o.
-
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 AccountHolderCapability fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of AccountHolderCapability given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of AccountHolderCapability
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to AccountHolderCapability
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of AccountHolderCapability to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-