Class Trust
- java.lang.Object
-
- com.adyen.model.legalentitymanagement.Trust
-
public class Trust extends Object
Trust
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTrust.TypeEnumType of trust.static classTrust.VatAbsenceReasonEnumThe reason for not providing a VAT number.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_COUNTRY_OF_GOVERNING_LAWstatic StringJSON_PROPERTY_DATE_OF_INCORPORATIONstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_DOING_BUSINESS_ASstatic StringJSON_PROPERTY_DOING_BUSINESS_AS_ABSENTstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESSstatic StringJSON_PROPERTY_REGISTERED_ADDRESSstatic StringJSON_PROPERTY_REGISTRATION_NUMBERstatic StringJSON_PROPERTY_TAX_INFORMATIONstatic StringJSON_PROPERTY_TYPEstatic StringJSON_PROPERTY_UNDEFINED_BENEFICIARY_INFOstatic StringJSON_PROPERTY_VAT_ABSENCE_REASONstatic StringJSON_PROPERTY_VAT_NUMBER
-
Constructor Summary
Constructors Constructor Description Trust()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TrustaddTaxInformationItem(TaxInformation taxInformationItem)TrustaddUndefinedBeneficiaryInfoItem(UndefinedBeneficiary undefinedBeneficiaryInfoItem)TrustcountryOfGoverningLaw(String countryOfGoverningLaw)The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.TrustdateOfIncorporation(String dateOfIncorporation)The date when the legal arrangement was incorporated in YYYY-MM-DD format.Trustdescription(String description)A short description about the trust.TrustdoingBusinessAs(String doingBusinessAs)The registered name, if different from the `name`.TrustdoingBusinessAsAbsent(Boolean doingBusinessAsAbsent)Set this to **true** if the legal arrangement does not have a `Doing business as` name.booleanequals(Object o)Return true if this Trust object is equal to o.static TrustfromJson(String jsonString)Create an instance of Trust given an JSON stringStringgetCountryOfGoverningLaw()The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.StringgetDateOfIncorporation()The date when the legal arrangement was incorporated in YYYY-MM-DD format.StringgetDescription()A short description about the trust.StringgetDoingBusinessAs()The registered name, if different from the `name`.BooleangetDoingBusinessAsAbsent()Set this to **true** if the legal arrangement does not have a `Doing business as` name.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.StringgetName()The legal name.AddressgetPrincipalPlaceOfBusiness()Get principalPlaceOfBusinessAddressgetRegisteredAddress()Get registeredAddressStringgetRegistrationNumber()The registration number.List<TaxInformation>getTaxInformation()The tax information of the entity.Trust.TypeEnumgetType()Type of trust.List<UndefinedBeneficiary>getUndefinedBeneficiaryInfo()The undefined beneficiary information of the entity.Trust.VatAbsenceReasonEnumgetVatAbsenceReason()The reason for not providing a VAT number.StringgetVatNumber()The VAT number.inthashCode()TrustincludeNullValues(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.Trustname(String name)The legal name.TrustprincipalPlaceOfBusiness(Address principalPlaceOfBusiness)principalPlaceOfBusinessTrustregisteredAddress(Address registeredAddress)registeredAddressTrustregistrationNumber(String registrationNumber)The registration number.voidsetCountryOfGoverningLaw(String countryOfGoverningLaw)The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.voidsetDateOfIncorporation(String dateOfIncorporation)The date when the legal arrangement was incorporated in YYYY-MM-DD format.voidsetDescription(String description)A short description about the trust.voidsetDoingBusinessAs(String doingBusinessAs)The registered name, if different from the `name`.voidsetDoingBusinessAsAbsent(Boolean doingBusinessAsAbsent)Set this to **true** if the legal arrangement does not have a `Doing business as` name.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetName(String name)The legal name.voidsetPrincipalPlaceOfBusiness(Address principalPlaceOfBusiness)principalPlaceOfBusinessvoidsetRegisteredAddress(Address registeredAddress)registeredAddressvoidsetRegistrationNumber(String registrationNumber)The registration number.voidsetTaxInformation(List<TaxInformation> taxInformation)The tax information of the entity.voidsetType(Trust.TypeEnum type)Type of trust.voidsetUndefinedBeneficiaryInfo(List<UndefinedBeneficiary> undefinedBeneficiaryInfo)The undefined beneficiary information of the entity.voidsetVatAbsenceReason(Trust.VatAbsenceReasonEnum vatAbsenceReason)The reason for not providing a VAT number.voidsetVatNumber(String vatNumber)The VAT number.TrusttaxInformation(List<TaxInformation> taxInformation)The tax information of the entity.StringtoJson()Convert an instance of Trust to an JSON stringStringtoString()Trusttype(Trust.TypeEnum type)Type of trust.TrustundefinedBeneficiaryInfo(List<UndefinedBeneficiary> undefinedBeneficiaryInfo)The undefined beneficiary information of the entity.TrustvatAbsenceReason(Trust.VatAbsenceReasonEnum vatAbsenceReason)The reason for not providing a VAT number.TrustvatNumber(String vatNumber)The VAT number.
-
-
-
Field Detail
-
JSON_PROPERTY_COUNTRY_OF_GOVERNING_LAW
public static final String JSON_PROPERTY_COUNTRY_OF_GOVERNING_LAW
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DATE_OF_INCORPORATION
public static final String JSON_PROPERTY_DATE_OF_INCORPORATION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DOING_BUSINESS_AS
public static final String JSON_PROPERTY_DOING_BUSINESS_AS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DOING_BUSINESS_AS_ABSENT
public static final String JSON_PROPERTY_DOING_BUSINESS_AS_ABSENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESS
public static final String JSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REGISTERED_ADDRESS
public static final String JSON_PROPERTY_REGISTERED_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REGISTRATION_NUMBER
public static final String JSON_PROPERTY_REGISTRATION_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TAX_INFORMATION
public static final String JSON_PROPERTY_TAX_INFORMATION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_UNDEFINED_BENEFICIARY_INFO
public static final String JSON_PROPERTY_UNDEFINED_BENEFICIARY_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VAT_ABSENCE_REASON
public static final String JSON_PROPERTY_VAT_ABSENCE_REASON
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VAT_NUMBER
public static final String JSON_PROPERTY_VAT_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
countryOfGoverningLaw
public Trust countryOfGoverningLaw(String countryOfGoverningLaw)
The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.- Parameters:
countryOfGoverningLaw- The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getCountryOfGoverningLaw
public String getCountryOfGoverningLaw()
The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.- Returns:
- countryOfGoverningLaw The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.
-
setCountryOfGoverningLaw
public void setCountryOfGoverningLaw(String countryOfGoverningLaw)
The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.- Parameters:
countryOfGoverningLaw- The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.
-
dateOfIncorporation
public Trust dateOfIncorporation(String dateOfIncorporation)
The date when the legal arrangement was incorporated in YYYY-MM-DD format.- Parameters:
dateOfIncorporation- The date when the legal arrangement was incorporated in YYYY-MM-DD format.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getDateOfIncorporation
public String getDateOfIncorporation()
The date when the legal arrangement was incorporated in YYYY-MM-DD format.- Returns:
- dateOfIncorporation The date when the legal arrangement was incorporated in YYYY-MM-DD format.
-
setDateOfIncorporation
public void setDateOfIncorporation(String dateOfIncorporation)
The date when the legal arrangement was incorporated in YYYY-MM-DD format.- Parameters:
dateOfIncorporation- The date when the legal arrangement was incorporated in YYYY-MM-DD format.
-
description
public Trust description(String description)
A short description about the trust. Only applicable for charitable trusts in New Zealand.- Parameters:
description- A short description about the trust. Only applicable for charitable trusts in New Zealand.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getDescription
public String getDescription()
A short description about the trust. Only applicable for charitable trusts in New Zealand.- Returns:
- description A short description about the trust. Only applicable for charitable trusts in New Zealand.
-
setDescription
public void setDescription(String description)
A short description about the trust. Only applicable for charitable trusts in New Zealand.- Parameters:
description- A short description about the trust. Only applicable for charitable trusts in New Zealand.
-
doingBusinessAs
public Trust doingBusinessAs(String doingBusinessAs)
The registered name, if different from the `name`.- Parameters:
doingBusinessAs- The registered name, if different from the `name`.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getDoingBusinessAs
public String getDoingBusinessAs()
The registered name, if different from the `name`.- Returns:
- doingBusinessAs The registered name, if different from the `name`.
-
setDoingBusinessAs
public void setDoingBusinessAs(String doingBusinessAs)
The registered name, if different from the `name`.- Parameters:
doingBusinessAs- The registered name, if different from the `name`.
-
doingBusinessAsAbsent
public Trust doingBusinessAsAbsent(Boolean doingBusinessAsAbsent)
Set this to **true** if the legal arrangement does not have a `Doing business as` name.- Parameters:
doingBusinessAsAbsent- Set this to **true** if the legal arrangement does not have a `Doing business as` name.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getDoingBusinessAsAbsent
public Boolean getDoingBusinessAsAbsent()
Set this to **true** if the legal arrangement does not have a `Doing business as` name.- Returns:
- doingBusinessAsAbsent Set this to **true** if the legal arrangement does not have a `Doing business as` name.
-
setDoingBusinessAsAbsent
public void setDoingBusinessAsAbsent(Boolean doingBusinessAsAbsent)
Set this to **true** if the legal arrangement does not have a `Doing business as` name.- Parameters:
doingBusinessAsAbsent- Set this to **true** if the legal arrangement does not have a `Doing business as` name.
-
name
public Trust name(String name)
The legal name.- Parameters:
name- The legal name.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getName
public String getName()
The legal name.- Returns:
- name The legal name.
-
setName
public void setName(String name)
The legal name.- Parameters:
name- The legal name.
-
principalPlaceOfBusiness
public Trust principalPlaceOfBusiness(Address principalPlaceOfBusiness)
principalPlaceOfBusiness- Parameters:
principalPlaceOfBusiness-- Returns:
- the current
Trustinstance, allowing for method chaining
-
getPrincipalPlaceOfBusiness
public Address getPrincipalPlaceOfBusiness()
Get principalPlaceOfBusiness- Returns:
- principalPlaceOfBusiness
-
setPrincipalPlaceOfBusiness
public void setPrincipalPlaceOfBusiness(Address principalPlaceOfBusiness)
principalPlaceOfBusiness- Parameters:
principalPlaceOfBusiness-
-
registeredAddress
public Trust registeredAddress(Address registeredAddress)
registeredAddress- Parameters:
registeredAddress-- Returns:
- the current
Trustinstance, allowing for method chaining
-
getRegisteredAddress
public Address getRegisteredAddress()
Get registeredAddress- Returns:
- registeredAddress
-
setRegisteredAddress
public void setRegisteredAddress(Address registeredAddress)
registeredAddress- Parameters:
registeredAddress-
-
registrationNumber
public Trust registrationNumber(String registrationNumber)
The registration number.- Parameters:
registrationNumber- The registration number.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getRegistrationNumber
public String getRegistrationNumber()
The registration number.- Returns:
- registrationNumber The registration number.
-
setRegistrationNumber
public void setRegistrationNumber(String registrationNumber)
The registration number.- Parameters:
registrationNumber- The registration number.
-
taxInformation
public Trust taxInformation(List<TaxInformation> taxInformation)
The tax information of the entity.- Parameters:
taxInformation- The tax information of the entity.- Returns:
- the current
Trustinstance, allowing for method chaining
-
addTaxInformationItem
public Trust addTaxInformationItem(TaxInformation taxInformationItem)
-
getTaxInformation
public List<TaxInformation> getTaxInformation()
The tax information of the entity.- Returns:
- taxInformation The tax information of the entity.
-
setTaxInformation
public void setTaxInformation(List<TaxInformation> taxInformation)
The tax information of the entity.- Parameters:
taxInformation- The tax information of the entity.
-
type
public Trust type(Trust.TypeEnum type)
Type of trust. See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia) and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).- Parameters:
type- Type of trust. See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia) and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).- Returns:
- the current
Trustinstance, allowing for method chaining
-
getType
public Trust.TypeEnum getType()
Type of trust. See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia) and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).- Returns:
- type Type of trust. See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia) and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).
-
setType
public void setType(Trust.TypeEnum type)
Type of trust. See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia) and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).- Parameters:
type- Type of trust. See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia) and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).
-
undefinedBeneficiaryInfo
public Trust undefinedBeneficiaryInfo(List<UndefinedBeneficiary> undefinedBeneficiaryInfo)
The undefined beneficiary information of the entity.- Parameters:
undefinedBeneficiaryInfo- The undefined beneficiary information of the entity.- Returns:
- the current
Trustinstance, allowing for method chaining
-
addUndefinedBeneficiaryInfoItem
public Trust addUndefinedBeneficiaryInfoItem(UndefinedBeneficiary undefinedBeneficiaryInfoItem)
-
getUndefinedBeneficiaryInfo
public List<UndefinedBeneficiary> getUndefinedBeneficiaryInfo()
The undefined beneficiary information of the entity.- Returns:
- undefinedBeneficiaryInfo The undefined beneficiary information of the entity.
-
setUndefinedBeneficiaryInfo
public void setUndefinedBeneficiaryInfo(List<UndefinedBeneficiary> undefinedBeneficiaryInfo)
The undefined beneficiary information of the entity.- Parameters:
undefinedBeneficiaryInfo- The undefined beneficiary information of the entity.
-
vatAbsenceReason
public Trust vatAbsenceReason(Trust.VatAbsenceReasonEnum vatAbsenceReason)
The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.- Parameters:
vatAbsenceReason- The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getVatAbsenceReason
public Trust.VatAbsenceReasonEnum getVatAbsenceReason()
The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.- Returns:
- vatAbsenceReason The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.
-
setVatAbsenceReason
public void setVatAbsenceReason(Trust.VatAbsenceReasonEnum vatAbsenceReason)
The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.- Parameters:
vatAbsenceReason- The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.
-
vatNumber
public Trust vatNumber(String vatNumber)
The VAT number.- Parameters:
vatNumber- The VAT number.- Returns:
- the current
Trustinstance, allowing for method chaining
-
getVatNumber
public String getVatNumber()
The VAT number.- Returns:
- vatNumber The VAT number.
-
setVatNumber
public void setVatNumber(String vatNumber)
The VAT number.- Parameters:
vatNumber- The VAT number.
-
includeNullValues
public Trust 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 Trust 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 Trust fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of Trust given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of Trust
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to Trust
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of Trust to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-