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

public class SweepConfigurationV2
extends Object

SweepConfigurationV2

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SweepConfigurationV2.ReasonEnum`	The reason for disabling the sweep.
`static class`	`SweepConfigurationV2.StatusEnum`	The status of the sweep.
`static class`	`SweepConfigurationV2.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_COUNTERPARTY`
`static String`	`JSON_PROPERTY_CURRENCY`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_REASON`
`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_TRIGGER_AMOUNT`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

SweepConfigurationV2()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SweepConfigurationV2`	`counterparty(SweepCounterparty counterparty)`
`SweepConfigurationV2`	`currency(String currency)`
`SweepConfigurationV2`	`description(String description)`
`boolean`	`equals(Object o)`	Return true if this SweepConfigurationV2 object is equal to o.
`static SweepConfigurationV2`	`fromJson(String jsonString)`	Create an instance of SweepConfigurationV2 given an JSON string
`SweepCounterparty`	`getCounterparty()`	Get counterparty
`String`	`getCurrency()`	The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase.
`String`	`getDescription()`	The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.
`String`	`getId()`	The unique identifier of the sweep.
`SweepConfigurationV2.ReasonEnum`	`getReason()`	The reason for disabling the sweep.
`SweepSchedule`	`getSchedule()`	Get schedule
`SweepConfigurationV2.StatusEnum`	`getStatus()`	The status of the sweep.
`Amount`	`getSweepAmount()`	Get sweepAmount
`Amount`	`getTargetAmount()`	Get targetAmount
`Amount`	`getTriggerAmount()`	Get triggerAmount
`SweepConfigurationV2.TypeEnum`	`getType()`	The direction of sweep, whether pushing out or pulling in funds to the balance account.
`int`	`hashCode()`
`SweepConfigurationV2`	`id(String id)`
`SweepConfigurationV2`	`reason(SweepConfigurationV2.ReasonEnum reason)`
`SweepConfigurationV2`	`schedule(SweepSchedule schedule)`
`void`	`setCounterparty(SweepCounterparty counterparty)`
`void`	`setCurrency(String currency)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setReason(SweepConfigurationV2.ReasonEnum reason)`
`void`	`setSchedule(SweepSchedule schedule)`
`void`	`setStatus(SweepConfigurationV2.StatusEnum status)`
`void`	`setSweepAmount(Amount sweepAmount)`
`void`	`setTargetAmount(Amount targetAmount)`
`void`	`setTriggerAmount(Amount triggerAmount)`
`void`	`setType(SweepConfigurationV2.TypeEnum type)`
`SweepConfigurationV2`	`status(SweepConfigurationV2.StatusEnum status)`
`SweepConfigurationV2`	`sweepAmount(Amount sweepAmount)`
`SweepConfigurationV2`	`targetAmount(Amount targetAmount)`
`String`	`toJson()`	Convert an instance of SweepConfigurationV2 to an JSON string
`String`	`toString()`
`SweepConfigurationV2`	`triggerAmount(Amount triggerAmount)`
`SweepConfigurationV2`	`type(SweepConfigurationV2.TypeEnum type)`

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

- Field Detail
  - JSON_PROPERTY_COUNTERPARTY
```
public static final String JSON_PROPERTY_COUNTERPARTY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CURRENCY
```
public static final String JSON_PROPERTY_CURRENCY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REASON
```
public static final String JSON_PROPERTY_REASON
```
    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_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
  - SweepConfigurationV2
```
public SweepConfigurationV2()
```
- Method Detail
  - counterparty
```
public SweepConfigurationV2 counterparty(SweepCounterparty counterparty)
```
  - getCounterparty
```
public SweepCounterparty getCounterparty()
```
    Get counterparty
    
    Returns:
    
    counterparty
  - setCounterparty
```
public void setCounterparty(SweepCounterparty counterparty)
```
  - currency
```
public SweepConfigurationV2 currency(String currency)
```
  - 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
  - setCurrency
```
public void setCurrency(String currency)
```
  - description
```
public SweepConfigurationV2 description(String description)
```
  - 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
  - setDescription
```
public void setDescription(String description)
```
  - id
```
public SweepConfigurationV2 id(String id)
```
  - getId
```
public String getId()
```
    The unique identifier of the sweep.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - reason
```
public SweepConfigurationV2 reason(SweepConfigurationV2.ReasonEnum reason)
```
  - getReason
```
public SweepConfigurationV2.ReasonEnum getReason()
```
    The reason for disabling the sweep.
    
    Returns:
    
    reason
  - setReason
```
public void setReason(SweepConfigurationV2.ReasonEnum reason)
```
  - schedule
```
public SweepConfigurationV2 schedule(SweepSchedule schedule)
```
  - getSchedule
```
public SweepSchedule getSchedule()
```
    Get schedule
    
    Returns:
    
    schedule
  - setSchedule
```
public void setSchedule(SweepSchedule schedule)
```
  - status
```
public SweepConfigurationV2 status(SweepConfigurationV2.StatusEnum status)
```
  - 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
  - setStatus
```
public void setStatus(SweepConfigurationV2.StatusEnum status)
```
  - sweepAmount
```
public SweepConfigurationV2 sweepAmount(Amount sweepAmount)
```
  - getSweepAmount
```
public Amount getSweepAmount()
```
    Get sweepAmount
    
    Returns:
    
    sweepAmount
  - setSweepAmount
```
public void setSweepAmount(Amount sweepAmount)
```
  - targetAmount
```
public SweepConfigurationV2 targetAmount(Amount targetAmount)
```
  - getTargetAmount
```
public Amount getTargetAmount()
```
    Get targetAmount
    
    Returns:
    
    targetAmount
  - setTargetAmount
```
public void setTargetAmount(Amount targetAmount)
```
  - triggerAmount
```
public SweepConfigurationV2 triggerAmount(Amount triggerAmount)
```
  - getTriggerAmount
```
public Amount getTriggerAmount()
```
    Get triggerAmount
    
    Returns:
    
    triggerAmount
  - setTriggerAmount
```
public void setTriggerAmount(Amount triggerAmount)
```
  - type
```
public SweepConfigurationV2 type(SweepConfigurationV2.TypeEnum type)
```
  - 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
  - setType
```
public void setType(SweepConfigurationV2.TypeEnum type)
```
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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

Class SweepConfigurationV2

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_COUNTERPARTY

JSON_PROPERTY_CURRENCY

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_ID

JSON_PROPERTY_REASON

JSON_PROPERTY_SCHEDULE

JSON_PROPERTY_STATUS

JSON_PROPERTY_SWEEP_AMOUNT

JSON_PROPERTY_TARGET_AMOUNT

JSON_PROPERTY_TRIGGER_AMOUNT

JSON_PROPERTY_TYPE

Constructor Detail

SweepConfigurationV2

Method Detail

counterparty

getCounterparty

setCounterparty

currency

getCurrency

setCurrency

description

getDescription

setDescription

id

getId

setId

reason

getReason

setReason

schedule

getSchedule

setSchedule

status

getStatus

setStatus

sweepAmount

getSweepAmount

setSweepAmount

targetAmount

getTargetAmount

setTargetAmount

triggerAmount

getTriggerAmount

setTriggerAmount

type

getType

setType

equals

hashCode

toString

fromJson

toJson