Class SourceOfFunds


  • public class SourceOfFunds
    extends Object
    SourceOfFunds
    • Constructor Detail

      • SourceOfFunds

        public SourceOfFunds()
    • Method Detail

      • adyenProcessedFunds

        public SourceOfFunds adyenProcessedFunds​(Boolean adyenProcessedFunds)
        Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.
        Parameters:
        adyenProcessedFunds - Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getAdyenProcessedFunds

        public Boolean getAdyenProcessedFunds()
        Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.
        Returns:
        adyenProcessedFunds Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.
      • setAdyenProcessedFunds

        public void setAdyenProcessedFunds​(Boolean adyenProcessedFunds)
        Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.
        Parameters:
        adyenProcessedFunds - Indicates whether the funds are coming from transactions processed by Adyen. If **false**, the `type` is required.
      • amount

        public SourceOfFunds amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount
      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -
      • assetMonthsHeld

        public SourceOfFunds assetMonthsHeld​(Integer assetMonthsHeld)
        The number of months that the asset has been in possession of the user. For example, if the source of funds is of type **cryptocurrencyIncome** then `assetMonthsHeld` is the number of months the user has owned the cryptocurrency.
        Parameters:
        assetMonthsHeld - The number of months that the asset has been in possession of the user. For example, if the source of funds is of type **cryptocurrencyIncome** then `assetMonthsHeld` is the number of months the user has owned the cryptocurrency.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getAssetMonthsHeld

        public Integer getAssetMonthsHeld()
        The number of months that the asset has been in possession of the user. For example, if the source of funds is of type **cryptocurrencyIncome** then `assetMonthsHeld` is the number of months the user has owned the cryptocurrency.
        Returns:
        assetMonthsHeld The number of months that the asset has been in possession of the user. For example, if the source of funds is of type **cryptocurrencyIncome** then `assetMonthsHeld` is the number of months the user has owned the cryptocurrency.
      • setAssetMonthsHeld

        public void setAssetMonthsHeld​(Integer assetMonthsHeld)
        The number of months that the asset has been in possession of the user. For example, if the source of funds is of type **cryptocurrencyIncome** then `assetMonthsHeld` is the number of months the user has owned the cryptocurrency.
        Parameters:
        assetMonthsHeld - The number of months that the asset has been in possession of the user. For example, if the source of funds is of type **cryptocurrencyIncome** then `assetMonthsHeld` is the number of months the user has owned the cryptocurrency.
      • cryptocurrencyExchange

        public SourceOfFunds cryptocurrencyExchange​(String cryptocurrencyExchange)
        Required if `type` is **cryptocurrencyIncome**. The cryptocurrency exchange where the funds were acquired.
        Parameters:
        cryptocurrencyExchange - Required if `type` is **cryptocurrencyIncome**. The cryptocurrency exchange where the funds were acquired.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getCryptocurrencyExchange

        public String getCryptocurrencyExchange()
        Required if `type` is **cryptocurrencyIncome**. The cryptocurrency exchange where the funds were acquired.
        Returns:
        cryptocurrencyExchange Required if `type` is **cryptocurrencyIncome**. The cryptocurrency exchange where the funds were acquired.
      • setCryptocurrencyExchange

        public void setCryptocurrencyExchange​(String cryptocurrencyExchange)
        Required if `type` is **cryptocurrencyIncome**. The cryptocurrency exchange where the funds were acquired.
        Parameters:
        cryptocurrencyExchange - Required if `type` is **cryptocurrencyIncome**. The cryptocurrency exchange where the funds were acquired.
      • dateOfFundsReceived

        public SourceOfFunds dateOfFundsReceived​(LocalDate dateOfFundsReceived)
        Required if `type` is **donations** or **inheritance**. The date the funds were received, in YYYY-MM-DD format.
        Parameters:
        dateOfFundsReceived - Required if `type` is **donations** or **inheritance**. The date the funds were received, in YYYY-MM-DD format.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getDateOfFundsReceived

        public LocalDate getDateOfFundsReceived()
        Required if `type` is **donations** or **inheritance**. The date the funds were received, in YYYY-MM-DD format.
        Returns:
        dateOfFundsReceived Required if `type` is **donations** or **inheritance**. The date the funds were received, in YYYY-MM-DD format.
      • setDateOfFundsReceived

        public void setDateOfFundsReceived​(LocalDate dateOfFundsReceived)
        Required if `type` is **donations** or **inheritance**. The date the funds were received, in YYYY-MM-DD format.
        Parameters:
        dateOfFundsReceived - Required if `type` is **donations** or **inheritance**. The date the funds were received, in YYYY-MM-DD format.
      • dateOfSourceEvent

        public SourceOfFunds dateOfSourceEvent​(LocalDate dateOfSourceEvent)
        Required if `type` is **assetSale** or **gamblingWinnings**. The date the funds were received, in YYYY-MM-DD format. For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.
        Parameters:
        dateOfSourceEvent - Required if `type` is **assetSale** or **gamblingWinnings**. The date the funds were received, in YYYY-MM-DD format. For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getDateOfSourceEvent

        public LocalDate getDateOfSourceEvent()
        Required if `type` is **assetSale** or **gamblingWinnings**. The date the funds were received, in YYYY-MM-DD format. For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.
        Returns:
        dateOfSourceEvent Required if `type` is **assetSale** or **gamblingWinnings**. The date the funds were received, in YYYY-MM-DD format. For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.
      • setDateOfSourceEvent

        public void setDateOfSourceEvent​(LocalDate dateOfSourceEvent)
        Required if `type` is **assetSale** or **gamblingWinnings**. The date the funds were received, in YYYY-MM-DD format. For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.
        Parameters:
        dateOfSourceEvent - Required if `type` is **assetSale** or **gamblingWinnings**. The date the funds were received, in YYYY-MM-DD format. For example, if the source of funds is of type **assetSale**, the dateOfSourceEvent is the date of the sale. If the source of funds is of type **gamblingWinnings**, the dateOfSourceEvent is the date of winnings.
      • description

        public SourceOfFunds description​(String description)
        Required if `type` is **business** or **assetSale**. A description for the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. For `type` **assetSale**, provide a description of the asset. For example, the address of a residential property if it is a property sale.
        Parameters:
        description - Required if `type` is **business** or **assetSale**. A description for the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. For `type` **assetSale**, provide a description of the asset. For example, the address of a residential property if it is a property sale.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getDescription

        public String getDescription()
        Required if `type` is **business** or **assetSale**. A description for the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. For `type` **assetSale**, provide a description of the asset. For example, the address of a residential property if it is a property sale.
        Returns:
        description Required if `type` is **business** or **assetSale**. A description for the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. For `type` **assetSale**, provide a description of the asset. For example, the address of a residential property if it is a property sale.
      • setDescription

        public void setDescription​(String description)
        Required if `type` is **business** or **assetSale**. A description for the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. For `type` **assetSale**, provide a description of the asset. For example, the address of a residential property if it is a property sale.
        Parameters:
        description - Required if `type` is **business** or **assetSale**. A description for the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. For `type` **assetSale**, provide a description of the asset. For example, the address of a residential property if it is a property sale.
      • financiers

        public SourceOfFunds financiers​(List<Financier> financiers)
        Required if `type` is **thirdPartyFunding**. Information about the financiers.
        Parameters:
        financiers - Required if `type` is **thirdPartyFunding**. Information about the financiers.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getFinanciers

        public List<Financier> getFinanciers()
        Required if `type` is **thirdPartyFunding**. Information about the financiers.
        Returns:
        financiers Required if `type` is **thirdPartyFunding**. Information about the financiers.
      • setFinanciers

        public void setFinanciers​(List<Financier> financiers)
        Required if `type` is **thirdPartyFunding**. Information about the financiers.
        Parameters:
        financiers - Required if `type` is **thirdPartyFunding**. Information about the financiers.
      • originatorLegalEntityId

        public SourceOfFunds originatorLegalEntityId​(String originatorLegalEntityId)
        Required if `type` is **donations** or **inheritance**. The legal entity ID representing the originator of the source of funds. For example, if the source of funds is **inheritance**, then `originatorOfFundsReference` should be the legal entity reference of the benefactor.
        Parameters:
        originatorLegalEntityId - Required if `type` is **donations** or **inheritance**. The legal entity ID representing the originator of the source of funds. For example, if the source of funds is **inheritance**, then `originatorOfFundsReference` should be the legal entity reference of the benefactor.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getOriginatorLegalEntityId

        public String getOriginatorLegalEntityId()
        Required if `type` is **donations** or **inheritance**. The legal entity ID representing the originator of the source of funds. For example, if the source of funds is **inheritance**, then `originatorOfFundsReference` should be the legal entity reference of the benefactor.
        Returns:
        originatorLegalEntityId Required if `type` is **donations** or **inheritance**. The legal entity ID representing the originator of the source of funds. For example, if the source of funds is **inheritance**, then `originatorOfFundsReference` should be the legal entity reference of the benefactor.
      • setOriginatorLegalEntityId

        public void setOriginatorLegalEntityId​(String originatorLegalEntityId)
        Required if `type` is **donations** or **inheritance**. The legal entity ID representing the originator of the source of funds. For example, if the source of funds is **inheritance**, then `originatorOfFundsReference` should be the legal entity reference of the benefactor.
        Parameters:
        originatorLegalEntityId - Required if `type` is **donations** or **inheritance**. The legal entity ID representing the originator of the source of funds. For example, if the source of funds is **inheritance**, then `originatorOfFundsReference` should be the legal entity reference of the benefactor.
      • purpose

        public SourceOfFunds purpose​(String purpose)
        Required if `type` is **donations**. The reason for receiving the funds.
        Parameters:
        purpose - Required if `type` is **donations**. The reason for receiving the funds.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getPurpose

        public String getPurpose()
        Required if `type` is **donations**. The reason for receiving the funds.
        Returns:
        purpose Required if `type` is **donations**. The reason for receiving the funds.
      • setPurpose

        public void setPurpose​(String purpose)
        Required if `type` is **donations**. The reason for receiving the funds.
        Parameters:
        purpose - Required if `type` is **donations**. The reason for receiving the funds.
      • relationship

        public SourceOfFunds relationship​(String relationship)
        Required if `type` is **donations** or **inheritance**. The relationship of the originator of the funds to the recipient.
        Parameters:
        relationship - Required if `type` is **donations** or **inheritance**. The relationship of the originator of the funds to the recipient.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getRelationship

        public String getRelationship()
        Required if `type` is **donations** or **inheritance**. The relationship of the originator of the funds to the recipient.
        Returns:
        relationship Required if `type` is **donations** or **inheritance**. The relationship of the originator of the funds to the recipient.
      • setRelationship

        public void setRelationship​(String relationship)
        Required if `type` is **donations** or **inheritance**. The relationship of the originator of the funds to the recipient.
        Parameters:
        relationship - Required if `type` is **donations** or **inheritance**. The relationship of the originator of the funds to the recipient.
      • type

        public SourceOfFunds type​(SourceOfFunds.TypeEnum type)
        The type of the source of funds. Possible values: * **business** * **employment** * **donations** * **inheritance** * **financialAid** * **rentalIncome** * **dividendIncome** * **royaltyIncome** * **thirdPartyFunding** * **pensionIncome** * **insuranceSettlement** * **cryptocurrencyIncome** * **assetSale** * **loans** * **gamblingWinnings**
        Parameters:
        type - The type of the source of funds. Possible values: * **business** * **employment** * **donations** * **inheritance** * **financialAid** * **rentalIncome** * **dividendIncome** * **royaltyIncome** * **thirdPartyFunding** * **pensionIncome** * **insuranceSettlement** * **cryptocurrencyIncome** * **assetSale** * **loans** * **gamblingWinnings**
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getType

        public SourceOfFunds.TypeEnum getType()
        The type of the source of funds. Possible values: * **business** * **employment** * **donations** * **inheritance** * **financialAid** * **rentalIncome** * **dividendIncome** * **royaltyIncome** * **thirdPartyFunding** * **pensionIncome** * **insuranceSettlement** * **cryptocurrencyIncome** * **assetSale** * **loans** * **gamblingWinnings**
        Returns:
        type The type of the source of funds. Possible values: * **business** * **employment** * **donations** * **inheritance** * **financialAid** * **rentalIncome** * **dividendIncome** * **royaltyIncome** * **thirdPartyFunding** * **pensionIncome** * **insuranceSettlement** * **cryptocurrencyIncome** * **assetSale** * **loans** * **gamblingWinnings**
      • setType

        public void setType​(SourceOfFunds.TypeEnum type)
        The type of the source of funds. Possible values: * **business** * **employment** * **donations** * **inheritance** * **financialAid** * **rentalIncome** * **dividendIncome** * **royaltyIncome** * **thirdPartyFunding** * **pensionIncome** * **insuranceSettlement** * **cryptocurrencyIncome** * **assetSale** * **loans** * **gamblingWinnings**
        Parameters:
        type - The type of the source of funds. Possible values: * **business** * **employment** * **donations** * **inheritance** * **financialAid** * **rentalIncome** * **dividendIncome** * **royaltyIncome** * **thirdPartyFunding** * **pensionIncome** * **insuranceSettlement** * **cryptocurrencyIncome** * **assetSale** * **loans** * **gamblingWinnings**
      • website

        public SourceOfFunds website​(String website)
        Required if `type` is **gamblingWinnings**. The location of the gambling site for the winnings. For example, if the source of funds is online gambling, provide the website of the gambling company.
        Parameters:
        website - Required if `type` is **gamblingWinnings**. The location of the gambling site for the winnings. For example, if the source of funds is online gambling, provide the website of the gambling company.
        Returns:
        the current SourceOfFunds instance, allowing for method chaining
      • getWebsite

        public String getWebsite()
        Required if `type` is **gamblingWinnings**. The location of the gambling site for the winnings. For example, if the source of funds is online gambling, provide the website of the gambling company.
        Returns:
        website Required if `type` is **gamblingWinnings**. The location of the gambling site for the winnings. For example, if the source of funds is online gambling, provide the website of the gambling company.
      • setWebsite

        public void setWebsite​(String website)
        Required if `type` is **gamblingWinnings**. The location of the gambling site for the winnings. For example, if the source of funds is online gambling, provide the website of the gambling company.
        Parameters:
        website - Required if `type` is **gamblingWinnings**. The location of the gambling site for the winnings. For example, if the source of funds is online gambling, provide the website of the gambling company.
      • includeNullValues

        public SourceOfFunds 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 SourceOfFunds object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • 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 SourceOfFunds fromJson​(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of SourceOfFunds given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of SourceOfFunds
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to SourceOfFunds
      • toJson

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