Package com.adyen.model.balanceplatform

Class SweepConfigurationV2

  • public class SweepConfigurationV2
extends Object
    SweepConfigurationV2

    • Method Detail

      • category

        public SweepConfigurationV2 category​(SweepConfigurationV2.CategoryEnum category)
        The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`.
        Parameters:
        category - The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`.
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getCategory

        public SweepConfigurationV2.CategoryEnum getCategory()
        The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`.
        Returns:
        category The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`.

      • setCategory

        public void setCategory​(SweepConfigurationV2.CategoryEnum category)
        The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`.
        Parameters:
        category - The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`.

      • counterparty

        public SweepConfigurationV2 counterparty​(SweepCounterparty counterparty)
        counterparty
        Parameters:
        counterparty -
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getCounterparty

        public SweepCounterparty getCounterparty()
        Get counterparty
        Returns:
        counterparty

      • setCounterparty

        public void setCounterparty​(SweepCounterparty counterparty)
        counterparty
        Parameters:
        counterparty -

      • currency

        public SweepConfigurationV2 currency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).
        Parameters:
        currency - The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getCurrency

        public String getCurrency()
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).
        Returns:
        currency The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).

      • setCurrency

        public void setCurrency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).
        Parameters:
        currency - The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).

      • description

        public SweepConfigurationV2 description​(String description)
        The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.
        Parameters:
        description - The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getDescription

        public String getDescription()
        The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.
        Returns:
        description The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.

      • setDescription

        public void setDescription​(String description)
        The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.
        Parameters:
        description - The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.

      • getId

        public String getId()
        The unique identifier of the sweep.
        Returns:
        id The unique identifier of the sweep.

      • priorities

        public SweepConfigurationV2 priorities​(List<SweepConfigurationV2.PrioritiesEnum> priorities)
        The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).
        Parameters:
        priorities - The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getPriorities

        public List<SweepConfigurationV2.PrioritiesEnum> getPriorities()
        The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).
        Returns:
        priorities The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).

      • setPriorities

        public void setPriorities​(List<SweepConfigurationV2.PrioritiesEnum> priorities)
        The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).
        Parameters:
        priorities - The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).

      • getReasonDetail

        public String getReasonDetail()
        The human readable reason for disabling the sweep.
        Returns:
        reasonDetail The human readable reason for disabling the sweep.

      • reference

        public SweepConfigurationV2 reference​(String reference)
        Your reference for the sweep configuration.
        Parameters:
        reference - Your reference for the sweep configuration.
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getReference

        public String getReference()
        Your reference for the sweep configuration.
        Returns:
        reference Your reference for the sweep configuration.

      • setReference

        public void setReference​(String reference)
        Your reference for the sweep configuration.
        Parameters:
        reference - Your reference for the sweep configuration.

      • referenceForBeneficiary

        public SweepConfigurationV2 referenceForBeneficiary​(String referenceForBeneficiary)
        The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
        Parameters:
        referenceForBeneficiary - The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getReferenceForBeneficiary

        public String getReferenceForBeneficiary()
        The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
        Returns:
        referenceForBeneficiary The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.

      • setReferenceForBeneficiary

        public void setReferenceForBeneficiary​(String referenceForBeneficiary)
        The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
        Parameters:
        referenceForBeneficiary - The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.

      • schedule

        public SweepConfigurationV2 schedule​(SweepSchedule schedule)
        schedule
        Parameters:
        schedule -
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getSchedule

        public SweepSchedule getSchedule()
        Get schedule
        Returns:
        schedule

      • setSchedule

        public void setSchedule​(SweepSchedule schedule)
        schedule
        Parameters:
        schedule -

      • status

        public SweepConfigurationV2 status​(SweepConfigurationV2.StatusEnum status)
        The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.
        Parameters:
        status - The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getStatus

        public SweepConfigurationV2.StatusEnum getStatus()
        The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.
        Returns:
        status The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.

      • setStatus

        public void setStatus​(SweepConfigurationV2.StatusEnum status)
        The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.
        Parameters:
        status - The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.

      • sweepAmount

        public SweepConfigurationV2 sweepAmount​(Amount sweepAmount)
        sweepAmount
        Parameters:
        sweepAmount -
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getSweepAmount

        public Amount getSweepAmount()
        Get sweepAmount
        Returns:
        sweepAmount

      • setSweepAmount

        public void setSweepAmount​(Amount sweepAmount)
        sweepAmount
        Parameters:
        sweepAmount -

      • targetAmount

        public SweepConfigurationV2 targetAmount​(Amount targetAmount)
        targetAmount
        Parameters:
        targetAmount -
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getTargetAmount

        public Amount getTargetAmount()
        Get targetAmount
        Returns:
        targetAmount

      • setTargetAmount

        public void setTargetAmount​(Amount targetAmount)
        targetAmount
        Parameters:
        targetAmount -

      • triggerAmount

        public SweepConfigurationV2 triggerAmount​(Amount triggerAmount)
        triggerAmount
        Parameters:
        triggerAmount -
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getTriggerAmount

        public Amount getTriggerAmount()
        Get triggerAmount
        Returns:
        triggerAmount

      • setTriggerAmount

        public void setTriggerAmount​(Amount triggerAmount)
        triggerAmount
        Parameters:
        triggerAmount -

      • type

        public SweepConfigurationV2 type​(SweepConfigurationV2.TypeEnum type)
        The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.
        Parameters:
        type - The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.
        Returns:
        the current SweepConfigurationV2 instance, allowing for method chaining

      • getType

        public SweepConfigurationV2.TypeEnum getType()
        The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.
        Returns:
        type The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.

      • setType

        public void setType​(SweepConfigurationV2.TypeEnum type)
        The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.
        Parameters:
        type - The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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