java.lang.Object
- com.adyen.model.configurationwebhooks.SweepConfiguration

public class SweepConfiguration
extends Object

SweepConfiguration

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SweepConfiguration.StatusEnum`	The status of the sweep.
`static class`	`SweepConfiguration.TypeEnum`	The direction of sweep, whether pushing out or pulling in funds to the balance account.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BALANCE_ACCOUNT_ID`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_SCHEDULE`
`static String`	`JSON_PROPERTY_STATUS`
`static String`	`JSON_PROPERTY_SWEEP_AMOUNT`
`static String`	`JSON_PROPERTY_TARGET_AMOUNT`
`static String`	`JSON_PROPERTY_TRANSFER_INSTRUMENT_ID`
`static String`	`JSON_PROPERTY_TRIGGER_AMOUNT`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

SweepConfiguration()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SweepConfiguration`	`balanceAccountId(String balanceAccountId)`
`boolean`	`equals(Object o)`	Return true if this SweepConfiguration object is equal to o.
`static SweepConfiguration`	`fromJson(String jsonString)`	Create an instance of SweepConfiguration given an JSON string
`String`	`getBalanceAccountId()`	The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
`String`	`getId()`	The unique identifier of the sweep.
`String`	`getMerchantAccount()`	The merchant account that will be the source of funds.
`SweepConfigurationSchedule`	`getSchedule()`	Get schedule
`SweepConfiguration.StatusEnum`	`getStatus()`	The status of the sweep.
`Amount`	`getSweepAmount()`	Get sweepAmount
`Amount`	`getTargetAmount()`	Get targetAmount
`String`	`getTransferInstrumentId()`	The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).
`Amount`	`getTriggerAmount()`	Get triggerAmount
`SweepConfiguration.TypeEnum`	`getType()`	The direction of sweep, whether pushing out or pulling in funds to the balance account.
`int`	`hashCode()`
`SweepConfiguration`	`id(String id)`
`SweepConfiguration`	`merchantAccount(String merchantAccount)`
`SweepConfiguration`	`schedule(SweepConfigurationSchedule schedule)`
`void`	`setBalanceAccountId(String balanceAccountId)`
`void`	`setId(String id)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setSchedule(SweepConfigurationSchedule schedule)`
`void`	`setStatus(SweepConfiguration.StatusEnum status)`
`void`	`setSweepAmount(Amount sweepAmount)`
`void`	`setTargetAmount(Amount targetAmount)`
`void`	`setTransferInstrumentId(String transferInstrumentId)`
`void`	`setTriggerAmount(Amount triggerAmount)`
`void`	`setType(SweepConfiguration.TypeEnum type)`
`SweepConfiguration`	`status(SweepConfiguration.StatusEnum status)`
`SweepConfiguration`	`sweepAmount(Amount sweepAmount)`
`SweepConfiguration`	`targetAmount(Amount targetAmount)`
`String`	`toJson()`	Convert an instance of SweepConfiguration to an JSON string
`String`	`toString()`
`SweepConfiguration`	`transferInstrumentId(String transferInstrumentId)`
`SweepConfiguration`	`triggerAmount(Amount triggerAmount)`
`SweepConfiguration`	`type(SweepConfiguration.TypeEnum type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_BALANCE_ACCOUNT_ID
```
public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SCHEDULE
```
public static final String JSON_PROPERTY_SCHEDULE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STATUS
```
public static final String JSON_PROPERTY_STATUS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SWEEP_AMOUNT
```
public static final String JSON_PROPERTY_SWEEP_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TARGET_AMOUNT
```
public static final String JSON_PROPERTY_TARGET_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRANSFER_INSTRUMENT_ID
```
public static final String JSON_PROPERTY_TRANSFER_INSTRUMENT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRIGGER_AMOUNT
```
public static final String JSON_PROPERTY_TRIGGER_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SweepConfiguration
```
public SweepConfiguration()
```
- Method Detail
  - balanceAccountId
```
public SweepConfiguration balanceAccountId(String balanceAccountId)
```
  - getBalanceAccountId
```
public String getBalanceAccountId()
```
    The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). You can only use this for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.
    
    Returns:
    
    balanceAccountId
  - setBalanceAccountId
```
public void setBalanceAccountId(String balanceAccountId)
```
  - id
```
public SweepConfiguration id(String id)
```
  - getId
```
public String getId()
```
    The unique identifier of the sweep.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - merchantAccount
```
public SweepConfiguration merchantAccount(String merchantAccount)
```
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account that will be the source of funds. You can only use this if you are processing payments with Adyen. This can only be used for sweeps of `type` **pull** and `schedule.type` **balance**.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
  - schedule
```
public SweepConfiguration schedule(SweepConfigurationSchedule schedule)
```
  - getSchedule
```
public SweepConfigurationSchedule getSchedule()
```
    Get schedule
    
    Returns:
    
    schedule
  - setSchedule
```
public void setSchedule(SweepConfigurationSchedule schedule)
```
  - status
```
public SweepConfiguration status(SweepConfiguration.StatusEnum status)
```
  - getStatus
```
public SweepConfiguration.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
  - setStatus
```
public void setStatus(SweepConfiguration.StatusEnum status)
```
  - sweepAmount
```
public SweepConfiguration sweepAmount(Amount sweepAmount)
```
  - getSweepAmount
```
public Amount getSweepAmount()
```
    Get sweepAmount
    
    Returns:
    
    sweepAmount
  - setSweepAmount
```
public void setSweepAmount(Amount sweepAmount)
```
  - targetAmount
```
public SweepConfiguration targetAmount(Amount targetAmount)
```
  - getTargetAmount
```
public Amount getTargetAmount()
```
    Get targetAmount
    
    Returns:
    
    targetAmount
  - setTargetAmount
```
public void setTargetAmount(Amount targetAmount)
```
  - transferInstrumentId
```
public SweepConfiguration transferInstrumentId(String transferInstrumentId)
```
  - getTransferInstrumentId
```
public String getTransferInstrumentId()
```
    The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id). You can also use this in combination with a `merchantAccount` and a `type` **pull** to start a direct debit request from the source transfer instrument. To use this feature, reach out to your Adyen contact.
    
    Returns:
    
    transferInstrumentId
  - setTransferInstrumentId
```
public void setTransferInstrumentId(String transferInstrumentId)
```
  - triggerAmount
```
public SweepConfiguration triggerAmount(Amount triggerAmount)
```
  - getTriggerAmount
```
public Amount getTriggerAmount()
```
    Get triggerAmount
    
    Returns:
    
    triggerAmount
  - setTriggerAmount
```
public void setTriggerAmount(Amount triggerAmount)
```
  - type
```
public SweepConfiguration type(SweepConfiguration.TypeEnum type)
```
  - getType
```
public SweepConfiguration.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
  - setType
```
public void setType(SweepConfiguration.TypeEnum type)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this SweepConfiguration object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static SweepConfiguration fromJson(String jsonString)
                                   throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of SweepConfiguration given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SweepConfiguration
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to SweepConfiguration
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of SweepConfiguration to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class SweepConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BALANCE_ACCOUNT_ID

JSON_PROPERTY_ID

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_SCHEDULE

JSON_PROPERTY_STATUS

JSON_PROPERTY_SWEEP_AMOUNT

JSON_PROPERTY_TARGET_AMOUNT

JSON_PROPERTY_TRANSFER_INSTRUMENT_ID

JSON_PROPERTY_TRIGGER_AMOUNT

JSON_PROPERTY_TYPE

Constructor Detail

SweepConfiguration

Method Detail

balanceAccountId

getBalanceAccountId

setBalanceAccountId

id

getId

setId

merchantAccount

getMerchantAccount

setMerchantAccount

schedule

getSchedule

setSchedule

status

getStatus

setStatus

sweepAmount

getSweepAmount

setSweepAmount

targetAmount

getTargetAmount

setTargetAmount

transferInstrumentId

getTransferInstrumentId

setTransferInstrumentId

triggerAmount

getTriggerAmount

setTriggerAmount

type

getType

setType

equals

hashCode

toString

fromJson

toJson