Package com.adyen.model.management
Class PayoutSettingsRequest
- java.lang.Object
-
- com.adyen.model.management.PayoutSettingsRequest
-
public class PayoutSettingsRequest extends Object
PayoutSettingsRequest
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ENABLEDstatic StringJSON_PROPERTY_ENABLED_FROM_DATEstatic StringJSON_PROPERTY_TRANSFER_INSTRUMENT_ID
-
Constructor Summary
Constructors Constructor Description PayoutSettingsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PayoutSettingsRequestenabled(Boolean enabled)Indicates if payouts to this bank account are enabled.PayoutSettingsRequestenabledFromDate(String enabledFromDate)The date when Adyen starts paying out to this bank account.booleanequals(Object o)Return true if this PayoutSettingsRequest object is equal to o.static PayoutSettingsRequestfromJson(String jsonString)Create an instance of PayoutSettingsRequest given an JSON stringBooleangetEnabled()Indicates if payouts to this bank account are enabled.StringgetEnabledFromDate()The date when Adyen starts paying out to this bank account.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.StringgetTransferInstrumentId()The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.inthashCode()PayoutSettingsRequestincludeNullValues(boolean includeNullValues)Configures whether null values are explicitly serialized in the JSON payload.booleanisIncludeNullValues()Returns whether null values are explicitly serialized in the JSON payload.voidsetEnabled(Boolean enabled)Indicates if payouts to this bank account are enabled.voidsetEnabledFromDate(String enabledFromDate)The date when Adyen starts paying out to this bank account.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetTransferInstrumentId(String transferInstrumentId)The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.StringtoJson()Convert an instance of PayoutSettingsRequest to an JSON stringStringtoString()PayoutSettingsRequesttransferInstrumentId(String transferInstrumentId)The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.
-
-
-
Field Detail
-
JSON_PROPERTY_ENABLED
public static final String JSON_PROPERTY_ENABLED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLED_FROM_DATE
public static final String JSON_PROPERTY_ENABLED_FROM_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANSFER_INSTRUMENT_ID
public static final String JSON_PROPERTY_TRANSFER_INSTRUMENT_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
enabled
public PayoutSettingsRequest enabled(Boolean enabled)
Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.- Parameters:
enabled- Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.- Returns:
- the current
PayoutSettingsRequestinstance, allowing for method chaining
-
getEnabled
public Boolean getEnabled()
Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.- Returns:
- enabled Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.
-
setEnabled
public void setEnabled(Boolean enabled)
Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.- Parameters:
enabled- Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.
-
enabledFromDate
public PayoutSettingsRequest enabledFromDate(String enabledFromDate)
The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.- Parameters:
enabledFromDate- The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.- Returns:
- the current
PayoutSettingsRequestinstance, allowing for method chaining
-
getEnabledFromDate
public String getEnabledFromDate()
The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.- Returns:
- enabledFromDate The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.
-
setEnabledFromDate
public void setEnabledFromDate(String enabledFromDate)
The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.- Parameters:
enabledFromDate- The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.
-
transferInstrumentId
public PayoutSettingsRequest transferInstrumentId(String transferInstrumentId)
The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.- Parameters:
transferInstrumentId- The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.- Returns:
- the current
PayoutSettingsRequestinstance, allowing for method chaining
-
getTransferInstrumentId
public String getTransferInstrumentId()
The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.- Returns:
- transferInstrumentId The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.
-
setTransferInstrumentId
public void setTransferInstrumentId(String transferInstrumentId)
The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.- Parameters:
transferInstrumentId- The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.
-
includeNullValues
public PayoutSettingsRequest 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 PayoutSettingsRequest object is equal to o.
-
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 PayoutSettingsRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of PayoutSettingsRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of PayoutSettingsRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to PayoutSettingsRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of PayoutSettingsRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-