java.lang.Object
- com.adyen.model.balanceplatform.TransferLimit

```
public class TransferLimit
extends Object
```
The transfer limit configured to regulate outgoing transfers.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_ENDS_AT`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_LIMIT_STATUS`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SCA_INFORMATION`
`static String`	`JSON_PROPERTY_SCOPE`
`static String`	`JSON_PROPERTY_STARTS_AT`
`static String`	`JSON_PROPERTY_TRANSFER_TYPE`

Constructor Summary

Constructors
Constructor Description

TransferLimit()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TransferLimit`	`amount(Amount amount)`	amount
`TransferLimit`	`endsAt(OffsetDateTime endsAt)`	The date and time when the transfer limit becomes inactive.
`boolean`	`equals(Object o)`	Return true if this TransferLimit object is equal to o.
`static TransferLimit`	`fromJson(String jsonString)`	Create an instance of TransferLimit given an JSON string
`Amount`	`getAmount()`	Get amount
`OffsetDateTime`	`getEndsAt()`	The date and time when the transfer limit becomes inactive.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getId()`	The unique identifier of the transfer limit.
`LimitStatus`	`getLimitStatus()`	Get limitStatus
`String`	`getReference()`	Your reference for the transfer limit.
`ScaInformation`	`getScaInformation()`	Get scaInformation
`Scope`	`getScope()`	Get scope
`OffsetDateTime`	`getStartsAt()`	The date and time when the transfer limit becomes active.
`TransferType`	`getTransferType()`	Get transferType
`int`	`hashCode()`
`TransferLimit`	`id(String id)`	The unique identifier of the transfer limit.
`TransferLimit`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`TransferLimit`	`limitStatus(LimitStatus limitStatus)`	limitStatus
`TransferLimit`	`reference(String reference)`	Your reference for the transfer limit.
`TransferLimit`	`scaInformation(ScaInformation scaInformation)`	scaInformation
`TransferLimit`	`scope(Scope scope)`	scope
`void`	`setAmount(Amount amount)`	amount
`void`	`setEndsAt(OffsetDateTime endsAt)`	The date and time when the transfer limit becomes inactive.
`void`	`setId(String id)`	The unique identifier of the transfer limit.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setLimitStatus(LimitStatus limitStatus)`	limitStatus
`void`	`setReference(String reference)`	Your reference for the transfer limit.
`void`	`setScaInformation(ScaInformation scaInformation)`	scaInformation
`void`	`setScope(Scope scope)`	scope
`void`	`setStartsAt(OffsetDateTime startsAt)`	The date and time when the transfer limit becomes active.
`void`	`setTransferType(TransferType transferType)`	transferType
`TransferLimit`	`startsAt(OffsetDateTime startsAt)`	The date and time when the transfer limit becomes active.
`String`	`toJson()`	Convert an instance of TransferLimit to an JSON string
`String`	`toString()`
`TransferLimit`	`transferType(TransferType transferType)`	transferType

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

- Field Detail
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ENDS_AT
```
public static final String JSON_PROPERTY_ENDS_AT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LIMIT_STATUS
```
public static final String JSON_PROPERTY_LIMIT_STATUS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SCA_INFORMATION
```
public static final String JSON_PROPERTY_SCA_INFORMATION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SCOPE
```
public static final String JSON_PROPERTY_SCOPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STARTS_AT
```
public static final String JSON_PROPERTY_STARTS_AT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRANSFER_TYPE
```
public static final String JSON_PROPERTY_TRANSFER_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransferLimit
```
public TransferLimit()
```
- Method Detail
  - amount
```
public TransferLimit amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - endsAt
```
public TransferLimit endsAt(OffsetDateTime endsAt)
```
    The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Parameters:
    
    endsAt - The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getEndsAt
```
public OffsetDateTime getEndsAt()
```
    The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Returns:
    
    endsAt The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
  - setEndsAt
```
public void setEndsAt(OffsetDateTime endsAt)
```
    The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Parameters:
    
    endsAt - The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
  - id
```
public TransferLimit id(String id)
```
    The unique identifier of the transfer limit.
    
    Parameters:
    
    id - The unique identifier of the transfer limit.
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getId
```
public String getId()
```
    The unique identifier of the transfer limit.
    
    Returns:
    
    id The unique identifier of the transfer limit.
  - setId
```
public void setId(String id)
```
    The unique identifier of the transfer limit.
    
    Parameters:
    
    id - The unique identifier of the transfer limit.
  - limitStatus
```
public TransferLimit limitStatus(LimitStatus limitStatus)
```
    limitStatus
    
    Parameters:
    
    limitStatus -
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getLimitStatus
```
public LimitStatus getLimitStatus()
```
    Get limitStatus
    
    Returns:
    
    limitStatus
  - setLimitStatus
```
public void setLimitStatus(LimitStatus limitStatus)
```
    limitStatus
    
    Parameters:
    
    limitStatus -
  - reference
```
public TransferLimit reference(String reference)
```
    Your reference for the transfer limit.
    
    Parameters:
    
    reference - Your reference for the transfer limit.
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getReference
```
public String getReference()
```
    Your reference for the transfer limit.
    
    Returns:
    
    reference Your reference for the transfer limit.
  - setReference
```
public void setReference(String reference)
```
    Your reference for the transfer limit.
    
    Parameters:
    
    reference - Your reference for the transfer limit.
  - scaInformation
```
public TransferLimit scaInformation(ScaInformation scaInformation)
```
    scaInformation
    
    Parameters:
    
    scaInformation -
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getScaInformation
```
public ScaInformation getScaInformation()
```
    Get scaInformation
    
    Returns:
    
    scaInformation
  - setScaInformation
```
public void setScaInformation(ScaInformation scaInformation)
```
    scaInformation
    
    Parameters:
    
    scaInformation -
  - scope
```
public TransferLimit scope(Scope scope)
```
    scope
    
    Parameters:
    
    scope -
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getScope
```
public Scope getScope()
```
    Get scope
    
    Returns:
    
    scope
  - setScope
```
public void setScope(Scope scope)
```
    scope
    
    Parameters:
    
    scope -
  - startsAt
```
public TransferLimit startsAt(OffsetDateTime startsAt)
```
    The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Parameters:
    
    startsAt - The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getStartsAt
```
public OffsetDateTime getStartsAt()
```
    The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Returns:
    
    startsAt The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
  - setStartsAt
```
public void setStartsAt(OffsetDateTime startsAt)
```
    The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
    
    Parameters:
    
    startsAt - The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
  - transferType
```
public TransferLimit transferType(TransferType transferType)
```
    transferType
    
    Parameters:
    
    transferType -
    
    Returns:
    
    the current TransferLimit instance, allowing for method chaining
  - getTransferType
```
public TransferType getTransferType()
```
    Get transferType
    
    Returns:
    
    transferType
  - setTransferType
```
public void setTransferType(TransferType transferType)
```
    transferType
    
    Parameters:
    
    transferType -
  - includeNullValues
```
public TransferLimit 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 TransferLimit 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
  - 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 TransferLimit fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of TransferLimit given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of TransferLimit
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to TransferLimit
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of TransferLimit to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class TransferLimit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_ENDS_AT

JSON_PROPERTY_ID

JSON_PROPERTY_LIMIT_STATUS

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SCA_INFORMATION

JSON_PROPERTY_SCOPE

JSON_PROPERTY_STARTS_AT

JSON_PROPERTY_TRANSFER_TYPE

Constructor Detail

TransferLimit

Method Detail

amount

getAmount

setAmount

endsAt

getEndsAt

setEndsAt

id

getId

setId

limitStatus

getLimitStatus

setLimitStatus

reference

getReference

setReference

scaInformation

getScaInformation

setScaInformation

scope

getScope

setScope

startsAt

getStartsAt

setStartsAt

transferType

getTransferType

setTransferType

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson