Package com.adyen.model.marketpayaccount

Class DocumentDetail

  • public class DocumentDetail
extends Object
    DocumentDetail

    • Constructor Detail

      • DocumentDetail

        public DocumentDetail()

    • Method Detail

      • getAccountHolderCode

        public String getAccountHolderCode()
        The code of account holder, to which the document applies.
        Returns:
        accountHolderCode

      • setAccountHolderCode

        public void setAccountHolderCode​(String accountHolderCode)

      • getBankAccountUUID

        public String getBankAccountUUID()
        The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. >Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.
        Returns:
        bankAccountUUID

      • setBankAccountUUID

        public void setBankAccountUUID​(String bankAccountUUID)

      • getDescription

        public String getDescription()
        Description of the document.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getDocumentType

        public DocumentDetail.DocumentTypeEnum getDocumentType()
        The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when each document type should be submitted and for the accepted file formats. Permitted values: * **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account. * **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document. * **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement. * **PASSPORT**: A file containing the identity page(s) of a passport. * **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted. * **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted. * **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted. * **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.
        Returns:
        documentType

      • getFilename

        public String getFilename()
        Filename of the document.
        Returns:
        filename

      • setFilename

        public void setFilename​(String filename)

      • legalArrangementCode

        public DocumentDetail legalArrangementCode​(String legalArrangementCode)

      • getLegalArrangementCode

        public String getLegalArrangementCode()
        The Adyen-generated [`legalArrangementCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementCode) to which the document must be linked.
        Returns:
        legalArrangementCode

      • setLegalArrangementCode

        public void setLegalArrangementCode​(String legalArrangementCode)

      • legalArrangementEntityCode

        public DocumentDetail legalArrangementEntityCode​(String legalArrangementEntityCode)

      • getLegalArrangementEntityCode

        public String getLegalArrangementEntityCode()
        The Adyen-generated [`legalArrangementEntityCode`](https://docs.adyen.com/api-explorer/#/Account/v6/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementEntities-legalArrangementEntityCode) to which the document must be linked.
        Returns:
        legalArrangementEntityCode

      • setLegalArrangementEntityCode

        public void setLegalArrangementEntityCode​(String legalArrangementEntityCode)

      • getShareholderCode

        public String getShareholderCode()
        The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when a document should be submitted. >Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**.
        Returns:
        shareholderCode

      • setShareholderCode

        public void setShareholderCode​(String shareholderCode)

      • getSignatoryCode

        public String getSignatoryCode()
        The Adyen-generated [`signatoryCode`](https://docs.adyen.com/api-explorer/#/Account/v6/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-signatories-signatoryCode) to which the document must be linked.
        Returns:
        signatoryCode

      • setSignatoryCode

        public void setSignatoryCode​(String signatoryCode)

      • equals

        public boolean equals​(Object o)
        Return true if this DocumentDetail object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static DocumentDetail fromJson​(String jsonString)
                               throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of DocumentDetail given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of DocumentDetail
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to DocumentDetail

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of DocumentDetail to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException