java.lang.Object
- com.adyen.model.marketpayaccount.LegalArrangementDetail

public class LegalArrangementDetail
extends Object

LegalArrangementDetail

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`LegalArrangementDetail.LegalFormEnum`	The form of legal arrangement.
`static class`	`LegalArrangementDetail.TypeEnum`	The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ADDRESS`
`static String`	`JSON_PROPERTY_LEGAL_ARRANGEMENT_CODE`
`static String`	`JSON_PROPERTY_LEGAL_ARRANGEMENT_ENTITIES`
`static String`	`JSON_PROPERTY_LEGAL_ARRANGEMENT_REFERENCE`
`static String`	`JSON_PROPERTY_LEGAL_FORM`
`static String`	`JSON_PROPERTY_NAME`
`static String`	`JSON_PROPERTY_REGISTRATION_NUMBER`
`static String`	`JSON_PROPERTY_TAX_NUMBER`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

LegalArrangementDetail()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LegalArrangementDetail`	`addLegalArrangementEntitiesItem(LegalArrangementEntityDetail legalArrangementEntitiesItem)`
`LegalArrangementDetail`	`address(ViasAddress address)`
`boolean`	`equals(Object o)`	Return true if this LegalArrangementDetail object is equal to o.
`static LegalArrangementDetail`	`fromJson(String jsonString)`	Create an instance of LegalArrangementDetail given an JSON string
`ViasAddress`	`getAddress()`	Get address
`String`	`getLegalArrangementCode()`	Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement.
`List<LegalArrangementEntityDetail>`	`getLegalArrangementEntities()`	An array containing information about other entities that are part of the legal arrangement.
`String`	`getLegalArrangementReference()`	Your reference for the legal arrangement.
`LegalArrangementDetail.LegalFormEnum`	`getLegalForm()`	The form of legal arrangement.
`String`	`getName()`	The legal name of the legal arrangement.
`String`	`getRegistrationNumber()`	The registration number of the legal arrangement.
`String`	`getTaxNumber()`	The tax identification number of the legal arrangement.
`LegalArrangementDetail.TypeEnum`	`getType()`	The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).
`int`	`hashCode()`
`LegalArrangementDetail`	`legalArrangementCode(String legalArrangementCode)`
`LegalArrangementDetail`	`legalArrangementEntities(List<LegalArrangementEntityDetail> legalArrangementEntities)`
`LegalArrangementDetail`	`legalArrangementReference(String legalArrangementReference)`
`LegalArrangementDetail`	`legalForm(LegalArrangementDetail.LegalFormEnum legalForm)`
`LegalArrangementDetail`	`name(String name)`
`LegalArrangementDetail`	`registrationNumber(String registrationNumber)`
`void`	`setAddress(ViasAddress address)`
`void`	`setLegalArrangementCode(String legalArrangementCode)`
`void`	`setLegalArrangementEntities(List<LegalArrangementEntityDetail> legalArrangementEntities)`
`void`	`setLegalArrangementReference(String legalArrangementReference)`
`void`	`setLegalForm(LegalArrangementDetail.LegalFormEnum legalForm)`
`void`	`setName(String name)`
`void`	`setRegistrationNumber(String registrationNumber)`
`void`	`setTaxNumber(String taxNumber)`
`void`	`setType(LegalArrangementDetail.TypeEnum type)`
`LegalArrangementDetail`	`taxNumber(String taxNumber)`
`String`	`toJson()`	Convert an instance of LegalArrangementDetail to an JSON string
`String`	`toString()`
`LegalArrangementDetail`	`type(LegalArrangementDetail.TypeEnum type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_ADDRESS
```
public static final String JSON_PROPERTY_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LEGAL_ARRANGEMENT_CODE
```
public static final String JSON_PROPERTY_LEGAL_ARRANGEMENT_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LEGAL_ARRANGEMENT_ENTITIES
```
public static final String JSON_PROPERTY_LEGAL_ARRANGEMENT_ENTITIES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LEGAL_ARRANGEMENT_REFERENCE
```
public static final String JSON_PROPERTY_LEGAL_ARRANGEMENT_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LEGAL_FORM
```
public static final String JSON_PROPERTY_LEGAL_FORM
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NAME
```
public static final String JSON_PROPERTY_NAME
```
    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_NUMBER
```
public static final String JSON_PROPERTY_TAX_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LegalArrangementDetail
```
public LegalArrangementDetail()
```
- Method Detail
  - address
```
public LegalArrangementDetail address(ViasAddress address)
```
  - getAddress
```
public ViasAddress getAddress()
```
    Get address
    
    Returns:
    
    address
  - setAddress
```
public void setAddress(ViasAddress address)
```
  - legalArrangementCode
```
public LegalArrangementDetail legalArrangementCode(String legalArrangementCode)
```
  - getLegalArrangementCode
```
public String getLegalArrangementCode()
```
    Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement. Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.
    
    Returns:
    
    legalArrangementCode
  - setLegalArrangementCode
```
public void setLegalArrangementCode(String legalArrangementCode)
```
  - legalArrangementEntities
```
public LegalArrangementDetail legalArrangementEntities(List<LegalArrangementEntityDetail> legalArrangementEntities)
```
  - addLegalArrangementEntitiesItem
```
public LegalArrangementDetail addLegalArrangementEntitiesItem(LegalArrangementEntityDetail legalArrangementEntitiesItem)
```
  - getLegalArrangementEntities
```
public List<LegalArrangementEntityDetail> getLegalArrangementEntities()
```
    An array containing information about other entities that are part of the legal arrangement.
    
    Returns:
    
    legalArrangementEntities
  - setLegalArrangementEntities
```
public void setLegalArrangementEntities(List<LegalArrangementEntityDetail> legalArrangementEntities)
```
  - legalArrangementReference
```
public LegalArrangementDetail legalArrangementReference(String legalArrangementReference)
```
  - getLegalArrangementReference
```
public String getLegalArrangementReference()
```
    Your reference for the legal arrangement. Must be between 3 to 128 characters.
    
    Returns:
    
    legalArrangementReference
  - setLegalArrangementReference
```
public void setLegalArrangementReference(String legalArrangementReference)
```
  - legalForm
```
public LegalArrangementDetail legalForm(LegalArrangementDetail.LegalFormEnum legalForm)
```
  - getLegalForm
```
public LegalArrangementDetail.LegalFormEnum getLegalForm()
```
    The form of legal arrangement. Required if `type` is **Trust** or **Partnership**. The possible values depend on the `type`. - For `type` **Trust**: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**. - For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, or **OtherPartnership**
    
    Returns:
    
    legalForm
  - setLegalForm
```
public void setLegalForm(LegalArrangementDetail.LegalFormEnum legalForm)
```
  - name
```
public LegalArrangementDetail name(String name)
```
  - getName
```
public String getName()
```
    The legal name of the legal arrangement. Minimum length: 3 characters.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - registrationNumber
```
public LegalArrangementDetail registrationNumber(String registrationNumber)
```
  - getRegistrationNumber
```
public String getRegistrationNumber()
```
    The registration number of the legal arrangement.
    
    Returns:
    
    registrationNumber
  - setRegistrationNumber
```
public void setRegistrationNumber(String registrationNumber)
```
  - taxNumber
```
public LegalArrangementDetail taxNumber(String taxNumber)
```
  - getTaxNumber
```
public String getTaxNumber()
```
    The tax identification number of the legal arrangement.
    
    Returns:
    
    taxNumber
  - setTaxNumber
```
public void setTaxNumber(String taxNumber)
```
  - type
```
public LegalArrangementDetail type(LegalArrangementDetail.TypeEnum type)
```
  - getType
```
public LegalArrangementDetail.TypeEnum getType()
```
    The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements). Possible values: - **Association** - **Partnership** - **SoleProprietorship** - **Trust**
    
    Returns:
    
    type
  - setType
```
public void setType(LegalArrangementDetail.TypeEnum type)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this LegalArrangementDetail 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 LegalArrangementDetail fromJson(String jsonString)
                                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of LegalArrangementDetail given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of LegalArrangementDetail
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to LegalArrangementDetail
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of LegalArrangementDetail to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class LegalArrangementDetail

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ADDRESS

JSON_PROPERTY_LEGAL_ARRANGEMENT_CODE

JSON_PROPERTY_LEGAL_ARRANGEMENT_ENTITIES

JSON_PROPERTY_LEGAL_ARRANGEMENT_REFERENCE

JSON_PROPERTY_LEGAL_FORM

JSON_PROPERTY_NAME

JSON_PROPERTY_REGISTRATION_NUMBER

JSON_PROPERTY_TAX_NUMBER

JSON_PROPERTY_TYPE

Constructor Detail

LegalArrangementDetail

Method Detail

address

getAddress

setAddress

legalArrangementCode

getLegalArrangementCode

setLegalArrangementCode

legalArrangementEntities

addLegalArrangementEntitiesItem

getLegalArrangementEntities

setLegalArrangementEntities

legalArrangementReference

getLegalArrangementReference

setLegalArrangementReference

legalForm

getLegalForm

setLegalForm

name

getName

setName

registrationNumber

getRegistrationNumber

setRegistrationNumber

taxNumber

getTaxNumber

setTaxNumber

type

getType

setType

equals

hashCode

toString

fromJson

toJson