Package com.adyen.model.legalentitymanagement

Class OnboardingLinkSettings

  • public class OnboardingLinkSettings
extends Object
    OnboardingLinkSettings

    • Field Detail

      • JSON_PROPERTY_ALLOW_BANK_ACCOUNT_FORMAT_SELECTION

        public static final String JSON_PROPERTY_ALLOW_BANK_ACCOUNT_FORMAT_SELECTION
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ALLOW_INTRA_REGION_CROSS_BORDER_PAYOUT

        public static final String JSON_PROPERTY_ALLOW_INTRA_REGION_CROSS_BORDER_PAYOUT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CHANGE_LEGAL_ENTITY_TYPE

        public static final String JSON_PROPERTY_CHANGE_LEGAL_ENTITY_TYPE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_EDIT_PREFILLED_COUNTRY

        public static final String JSON_PROPERTY_EDIT_PREFILLED_COUNTRY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_INDIVIDUAL

        public static final String JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_INDIVIDUAL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_ORGANIZATION

        public static final String JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_ORGANIZATION
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_SOLE_PROPRIETOR

        public static final String JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_SOLE_PROPRIETOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_TRUST

        public static final String JSON_PROPERTY_HIDE_ONBOARDING_INTRODUCTION_TRUST
        See Also:
        Constant Field Values

      • JSON_PROPERTY_INSTANT_BANK_VERIFICATION

        public static final String JSON_PROPERTY_INSTANT_BANK_VERIFICATION
        See Also:
        Constant Field Values

      • JSON_PROPERTY_REQUIRE_PCI_SIGN_ECOM_MOTO

        public static final String JSON_PROPERTY_REQUIRE_PCI_SIGN_ECOM_MOTO
        See Also:
        Constant Field Values

      • JSON_PROPERTY_REQUIRE_PCI_SIGN_ECOMMERCE

        public static final String JSON_PROPERTY_REQUIRE_PCI_SIGN_ECOMMERCE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_REQUIRE_PCI_SIGN_POS_MOTO

        public static final String JSON_PROPERTY_REQUIRE_PCI_SIGN_POS_MOTO
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TRANSFER_INSTRUMENT_LIMIT

        public static final String JSON_PROPERTY_TRANSFER_INSTRUMENT_LIMIT
        See Also:
        Constant Field Values

    • Constructor Detail

      • OnboardingLinkSettings

        public OnboardingLinkSettings()

    • Method Detail

      • acceptedCountries

        public OnboardingLinkSettings acceptedCountries​(List<String> acceptedCountries)
        The list of countries the user can choose from in hosted onboarding when `editPrefilledCountry` is allowed. The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).
        Parameters:
        acceptedCountries -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getAcceptedCountries

        public List<String> getAcceptedCountries()
        The list of countries the user can choose from in hosted onboarding when `editPrefilledCountry` is allowed. The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).
        Returns:
        acceptedCountries

      • setAcceptedCountries

        public void setAcceptedCountries​(List<String> acceptedCountries)
        The list of countries the user can choose from in hosted onboarding when `editPrefilledCountry` is allowed. The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).
        Parameters:
        acceptedCountries -

      • allowBankAccountFormatSelection

        public OnboardingLinkSettings allowBankAccountFormatSelection​(Boolean allowBankAccountFormatSelection)
        Default value: **false** Indicates if the user can select the format for their payout account (if applicable).
        Parameters:
        allowBankAccountFormatSelection -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getAllowBankAccountFormatSelection

        public Boolean getAllowBankAccountFormatSelection()
        Default value: **false** Indicates if the user can select the format for their payout account (if applicable).
        Returns:
        allowBankAccountFormatSelection

      • setAllowBankAccountFormatSelection

        public void setAllowBankAccountFormatSelection​(Boolean allowBankAccountFormatSelection)
        Default value: **false** Indicates if the user can select the format for their payout account (if applicable).
        Parameters:
        allowBankAccountFormatSelection -

      • allowIntraRegionCrossBorderPayout

        public OnboardingLinkSettings allowIntraRegionCrossBorderPayout​(Boolean allowIntraRegionCrossBorderPayout)
        Default value: **false** Indicates if the user can select a payout account in a different EU/EEA location (including Switzerland and the UK) than the location of their legal entity.
        Parameters:
        allowIntraRegionCrossBorderPayout -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getAllowIntraRegionCrossBorderPayout

        public Boolean getAllowIntraRegionCrossBorderPayout()
        Default value: **false** Indicates if the user can select a payout account in a different EU/EEA location (including Switzerland and the UK) than the location of their legal entity.
        Returns:
        allowIntraRegionCrossBorderPayout

      • setAllowIntraRegionCrossBorderPayout

        public void setAllowIntraRegionCrossBorderPayout​(Boolean allowIntraRegionCrossBorderPayout)
        Default value: **false** Indicates if the user can select a payout account in a different EU/EEA location (including Switzerland and the UK) than the location of their legal entity.
        Parameters:
        allowIntraRegionCrossBorderPayout -

      • changeLegalEntityType

        public OnboardingLinkSettings changeLegalEntityType​(Boolean changeLegalEntityType)
        Default value: **true** Indicates if the user can change their legal entity type.
        Parameters:
        changeLegalEntityType -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getChangeLegalEntityType

        public Boolean getChangeLegalEntityType()
        Default value: **true** Indicates if the user can change their legal entity type.
        Returns:
        changeLegalEntityType

      • setChangeLegalEntityType

        public void setChangeLegalEntityType​(Boolean changeLegalEntityType)
        Default value: **true** Indicates if the user can change their legal entity type.
        Parameters:
        changeLegalEntityType -

      • editPrefilledCountry

        public OnboardingLinkSettings editPrefilledCountry​(Boolean editPrefilledCountry)
        Default value: **true** Indicates if the user can change the country of their legal entity's address, for example the registered address of an organization.
        Parameters:
        editPrefilledCountry -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getEditPrefilledCountry

        public Boolean getEditPrefilledCountry()
        Default value: **true** Indicates if the user can change the country of their legal entity's address, for example the registered address of an organization.
        Returns:
        editPrefilledCountry

      • setEditPrefilledCountry

        public void setEditPrefilledCountry​(Boolean editPrefilledCountry)
        Default value: **true** Indicates if the user can change the country of their legal entity's address, for example the registered address of an organization.
        Parameters:
        editPrefilledCountry -

      • enforceLegalAge

        public OnboardingLinkSettings enforceLegalAge​(Boolean enforceLegalAge)
        Default value: **false** Indicates if only users above the age of 18 can be onboarded.
        Parameters:
        enforceLegalAge -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getEnforceLegalAge

        public Boolean getEnforceLegalAge()
        Default value: **false** Indicates if only users above the age of 18 can be onboarded.
        Returns:
        enforceLegalAge

      • setEnforceLegalAge

        public void setEnforceLegalAge​(Boolean enforceLegalAge)
        Default value: **false** Indicates if only users above the age of 18 can be onboarded.
        Parameters:
        enforceLegalAge -

      • hideOnboardingIntroductionIndividual

        public OnboardingLinkSettings hideOnboardingIntroductionIndividual​(Boolean hideOnboardingIntroductionIndividual)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the individual legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionIndividual -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getHideOnboardingIntroductionIndividual

        public Boolean getHideOnboardingIntroductionIndividual()
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the individual legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Returns:
        hideOnboardingIntroductionIndividual

      • setHideOnboardingIntroductionIndividual

        public void setHideOnboardingIntroductionIndividual​(Boolean hideOnboardingIntroductionIndividual)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the individual legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionIndividual -

      • hideOnboardingIntroductionOrganization

        public OnboardingLinkSettings hideOnboardingIntroductionOrganization​(Boolean hideOnboardingIntroductionOrganization)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the organization legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionOrganization -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getHideOnboardingIntroductionOrganization

        public Boolean getHideOnboardingIntroductionOrganization()
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the organization legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Returns:
        hideOnboardingIntroductionOrganization

      • setHideOnboardingIntroductionOrganization

        public void setHideOnboardingIntroductionOrganization​(Boolean hideOnboardingIntroductionOrganization)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the organization legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionOrganization -

      • hideOnboardingIntroductionSoleProprietor

        public OnboardingLinkSettings hideOnboardingIntroductionSoleProprietor​(Boolean hideOnboardingIntroductionSoleProprietor)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the sole proprietorship legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionSoleProprietor -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getHideOnboardingIntroductionSoleProprietor

        public Boolean getHideOnboardingIntroductionSoleProprietor()
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the sole proprietorship legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Returns:
        hideOnboardingIntroductionSoleProprietor

      • setHideOnboardingIntroductionSoleProprietor

        public void setHideOnboardingIntroductionSoleProprietor​(Boolean hideOnboardingIntroductionSoleProprietor)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the sole proprietorship legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionSoleProprietor -

      • hideOnboardingIntroductionTrust

        public OnboardingLinkSettings hideOnboardingIntroductionTrust​(Boolean hideOnboardingIntroductionTrust)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the trust legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionTrust -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getHideOnboardingIntroductionTrust

        public Boolean getHideOnboardingIntroductionTrust()
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the trust legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Returns:
        hideOnboardingIntroductionTrust

      • setHideOnboardingIntroductionTrust

        public void setHideOnboardingIntroductionTrust​(Boolean hideOnboardingIntroductionTrust)
        Default value: **true** Indicates whether the introduction screen is hidden for the user of the trust legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.
        Parameters:
        hideOnboardingIntroductionTrust -

      • instantBankVerification

        public OnboardingLinkSettings instantBankVerification​(Boolean instantBankVerification)
        Default value: **true** Indicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.
        Parameters:
        instantBankVerification -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getInstantBankVerification

        public Boolean getInstantBankVerification()
        Default value: **true** Indicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.
        Returns:
        instantBankVerification

      • setInstantBankVerification

        public void setInstantBankVerification​(Boolean instantBankVerification)
        Default value: **true** Indicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.
        Parameters:
        instantBankVerification -

      • requirePciSignEcomMoto

        public OnboardingLinkSettings requirePciSignEcomMoto​(Boolean requirePciSignEcomMoto)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type.
        Parameters:
        requirePciSignEcomMoto -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getRequirePciSignEcomMoto

        public Boolean getRequirePciSignEcomMoto()
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type.
        Returns:
        requirePciSignEcomMoto

      • setRequirePciSignEcomMoto

        public void setRequirePciSignEcomMoto​(Boolean requirePciSignEcomMoto)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type.
        Parameters:
        requirePciSignEcomMoto -

      • requirePciSignEcommerce

        public OnboardingLinkSettings requirePciSignEcommerce​(Boolean requirePciSignEcommerce)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type.
        Parameters:
        requirePciSignEcommerce -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getRequirePciSignEcommerce

        public Boolean getRequirePciSignEcommerce()
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type.
        Returns:
        requirePciSignEcommerce

      • setRequirePciSignEcommerce

        public void setRequirePciSignEcommerce​(Boolean requirePciSignEcommerce)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type.
        Parameters:
        requirePciSignEcommerce -

      • requirePciSignPos

        public OnboardingLinkSettings requirePciSignPos​(Boolean requirePciSignPos)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type.
        Parameters:
        requirePciSignPos -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getRequirePciSignPos

        public Boolean getRequirePciSignPos()
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type.
        Returns:
        requirePciSignPos

      • setRequirePciSignPos

        public void setRequirePciSignPos​(Boolean requirePciSignPos)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type.
        Parameters:
        requirePciSignPos -

      • requirePciSignPosMoto

        public OnboardingLinkSettings requirePciSignPosMoto​(Boolean requirePciSignPosMoto)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type.
        Parameters:
        requirePciSignPosMoto -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getRequirePciSignPosMoto

        public Boolean getRequirePciSignPosMoto()
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type.
        Returns:
        requirePciSignPosMoto

      • setRequirePciSignPosMoto

        public void setRequirePciSignPosMoto​(Boolean requirePciSignPosMoto)
        Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type.
        Parameters:
        requirePciSignPosMoto -

      • transferInstrumentLimit

        public OnboardingLinkSettings transferInstrumentLimit​(Integer transferInstrumentLimit)
        The maximum number of transfer instruments the user can create.
        Parameters:
        transferInstrumentLimit -
        Returns:
        the current OnboardingLinkSettings instance, allowing for method chaining

      • getTransferInstrumentLimit

        public Integer getTransferInstrumentLimit()
        The maximum number of transfer instruments the user can create.
        Returns:
        transferInstrumentLimit

      • setTransferInstrumentLimit

        public void setTransferInstrumentLimit​(Integer transferInstrumentLimit)
        The maximum number of transfer instruments the user can create.
        Parameters:
        transferInstrumentLimit -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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