Class Document
- java.lang.Object
-
- com.adyen.model.legalentitymanagement.Document
-
public class Document extends Object
Document
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDocument.TypeEnumType of document, used when providing an ID number or uploading a document.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ATTACHMENTstatic StringJSON_PROPERTY_ATTACHMENTSstatic StringJSON_PROPERTY_CREATION_DATEstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_EXPIRY_DATEstatic StringJSON_PROPERTY_FILE_NAMEstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_ISSUER_COUNTRYstatic StringJSON_PROPERTY_ISSUER_STATEstatic StringJSON_PROPERTY_MODIFICATION_DATEstatic StringJSON_PROPERTY_NUMBERstatic StringJSON_PROPERTY_OWNERstatic StringJSON_PROPERTY_TYPE
-
Constructor Summary
Constructors Constructor Description Document()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DocumentaddAttachmentsItem(Attachment attachmentsItem)Documentattachment(Attachment attachment)Documentattachments(List<Attachment> attachments)DocumentcreationDate(OffsetDateTime creationDate)Documentdescription(String description)booleanequals(Object o)Return true if this Document object is equal to o.DocumentexpiryDate(String expiryDate)Deprecated.DocumentfileName(String fileName)static DocumentfromJson(String jsonString)Create an instance of Document given an JSON stringAttachmentgetAttachment()Get attachmentList<Attachment>getAttachments()Array that contains the document.OffsetDateTimegetCreationDate()The creation date of the document.StringgetDescription()Your description for the document.StringgetExpiryDate()Deprecated.StringgetFileName()The filename of the document.StringgetId()The unique identifier of the document.StringgetIssuerCountry()Deprecated.StringgetIssuerState()Deprecated.OffsetDateTimegetModificationDate()The modification date of the document.StringgetNumber()The number in the document.OwnerEntitygetOwner()Get ownerDocument.TypeEnumgetType()Type of document, used when providing an ID number or uploading a document.inthashCode()Documentid(String id)DocumentissuerCountry(String issuerCountry)Deprecated.DocumentissuerState(String issuerState)Deprecated.DocumentmodificationDate(OffsetDateTime modificationDate)Documentnumber(String number)Documentowner(OwnerEntity owner)voidsetAttachment(Attachment attachment)attachmentvoidsetAttachments(List<Attachment> attachments)Array that contains the document.voidsetCreationDate(OffsetDateTime creationDate)The creation date of the document.voidsetDescription(String description)Your description for the document.voidsetExpiryDate(String expiryDate)Deprecated.voidsetFileName(String fileName)The filename of the document.voidsetId(String id)The unique identifier of the document.voidsetIssuerCountry(String issuerCountry)Deprecated.voidsetIssuerState(String issuerState)Deprecated.voidsetModificationDate(OffsetDateTime modificationDate)The modification date of the document.voidsetNumber(String number)The number in the document.voidsetOwner(OwnerEntity owner)ownervoidsetType(Document.TypeEnum type)Type of document, used when providing an ID number or uploading a document.StringtoJson()Convert an instance of Document to an JSON stringStringtoString()Documenttype(Document.TypeEnum type)
-
-
-
Field Detail
-
JSON_PROPERTY_ATTACHMENT
public static final String JSON_PROPERTY_ATTACHMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ATTACHMENTS
public static final String JSON_PROPERTY_ATTACHMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CREATION_DATE
public static final String JSON_PROPERTY_CREATION_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXPIRY_DATE
public static final String JSON_PROPERTY_EXPIRY_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FILE_NAME
public static final String JSON_PROPERTY_FILE_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ISSUER_COUNTRY
public static final String JSON_PROPERTY_ISSUER_COUNTRY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ISSUER_STATE
public static final String JSON_PROPERTY_ISSUER_STATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MODIFICATION_DATE
public static final String JSON_PROPERTY_MODIFICATION_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NUMBER
public static final String JSON_PROPERTY_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_OWNER
public static final String JSON_PROPERTY_OWNER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
attachment
public Document attachment(Attachment attachment)
-
getAttachment
public Attachment getAttachment()
Get attachment- Returns:
- attachment
-
setAttachment
public void setAttachment(Attachment attachment)
attachment- Parameters:
attachment-
-
attachments
public Document attachments(List<Attachment> attachments)
-
addAttachmentsItem
public Document addAttachmentsItem(Attachment attachmentsItem)
-
getAttachments
public List<Attachment> getAttachments()
Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.- Returns:
- attachments
-
setAttachments
public void setAttachments(List<Attachment> attachments)
Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.- Parameters:
attachments-
-
creationDate
public Document creationDate(OffsetDateTime creationDate)
-
getCreationDate
public OffsetDateTime getCreationDate()
The creation date of the document.- Returns:
- creationDate
-
setCreationDate
public void setCreationDate(OffsetDateTime creationDate)
The creation date of the document.- Parameters:
creationDate-
-
getDescription
public String getDescription()
Your description for the document.- Returns:
- description
-
setDescription
public void setDescription(String description)
Your description for the document.- Parameters:
description-
-
expiryDate
@Deprecated public Document expiryDate(String expiryDate)
Deprecated.
-
getExpiryDate
@Deprecated public String getExpiryDate()
Deprecated.The expiry date of the document, in YYYY-MM-DD format.- Returns:
- expiryDate
-
setExpiryDate
@Deprecated public void setExpiryDate(String expiryDate)
Deprecated.The expiry date of the document, in YYYY-MM-DD format.- Parameters:
expiryDate-
-
getFileName
public String getFileName()
The filename of the document.- Returns:
- fileName
-
setFileName
public void setFileName(String fileName)
The filename of the document.- Parameters:
fileName-
-
getId
public String getId()
The unique identifier of the document.- Returns:
- id
-
setId
public void setId(String id)
The unique identifier of the document.- Parameters:
id-
-
issuerCountry
@Deprecated public Document issuerCountry(String issuerCountry)
Deprecated.
-
getIssuerCountry
@Deprecated public String getIssuerCountry()
Deprecated.The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.- Returns:
- issuerCountry
-
setIssuerCountry
@Deprecated public void setIssuerCountry(String issuerCountry)
Deprecated.The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.- Parameters:
issuerCountry-
-
issuerState
@Deprecated public Document issuerState(String issuerState)
Deprecated.
-
getIssuerState
@Deprecated public String getIssuerState()
Deprecated.The state or province where the document was issued (AU only).- Returns:
- issuerState
-
setIssuerState
@Deprecated public void setIssuerState(String issuerState)
Deprecated.The state or province where the document was issued (AU only).- Parameters:
issuerState-
-
modificationDate
public Document modificationDate(OffsetDateTime modificationDate)
-
getModificationDate
public OffsetDateTime getModificationDate()
The modification date of the document.- Returns:
- modificationDate
-
setModificationDate
public void setModificationDate(OffsetDateTime modificationDate)
The modification date of the document.- Parameters:
modificationDate-
-
getNumber
public String getNumber()
The number in the document.- Returns:
- number
-
setNumber
public void setNumber(String number)
The number in the document.- Parameters:
number-
-
owner
public Document owner(OwnerEntity owner)
-
getOwner
public OwnerEntity getOwner()
Get owner- Returns:
- owner
-
setOwner
public void setOwner(OwnerEntity owner)
owner- Parameters:
owner-
-
type
public Document type(Document.TypeEnum type)
-
getType
public Document.TypeEnum getType()
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value can be **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).- Returns:
- type
-
setType
public void setType(Document.TypeEnum type)
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value can be **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).- Parameters:
type-
-
equals
public boolean equals(Object o)
Return true if this Document object is equal to o.
-
fromJson
public static Document fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of Document given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of Document
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to Document
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of Document to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-