Package com.adyen.model.management

Class PayoutSettings

  • public class PayoutSettings
extends Object
    PayoutSettings

    • Constructor Detail

      • PayoutSettings

        public PayoutSettings()

    • Method Detail

      • allowed

        public PayoutSettings allowed​(Boolean allowed)
        Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is: * **true** if `verificationStatus` is **valid**. * **false** for all other values.
        Parameters:
        allowed -
        Returns:
        the current PayoutSettings instance, allowing for method chaining

      • getAllowed

        public Boolean getAllowed()
        Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is: * **true** if `verificationStatus` is **valid**. * **false** for all other values.
        Returns:
        allowed

      • setAllowed

        public void setAllowed​(Boolean allowed)
        Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is: * **true** if `verificationStatus` is **valid**. * **false** for all other values.
        Parameters:
        allowed -

      • enabled

        public PayoutSettings 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 -
        Returns:
        the current PayoutSettings instance, 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

      • 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 -

      • enabledFromDate

        public PayoutSettings 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 -
        Returns:
        the current PayoutSettings instance, 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

      • 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 -

      • id

        public PayoutSettings id​(String id)
        The unique identifier of the payout setting.
        Parameters:
        id -
        Returns:
        the current PayoutSettings instance, allowing for method chaining

      • getId

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

      • setId

        public void setId​(String id)
        The unique identifier of the payout setting.
        Parameters:
        id -

      • priority

        public PayoutSettings priority​(PayoutSettings.PriorityEnum priority)
        Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account. Possible values: * **first**: same day. * **urgent**: the next day. * **normal**: between 1 and 3 days.
        Parameters:
        priority -
        Returns:
        the current PayoutSettings instance, allowing for method chaining

      • getPriority

        public PayoutSettings.PriorityEnum getPriority()
        Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account. Possible values: * **first**: same day. * **urgent**: the next day. * **normal**: between 1 and 3 days.
        Returns:
        priority

      • setPriority

        public void setPriority​(PayoutSettings.PriorityEnum priority)
        Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account. Possible values: * **first**: same day. * **urgent**: the next day. * **normal**: between 1 and 3 days.
        Parameters:
        priority -

      • transferInstrumentId

        public PayoutSettings 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 -
        Returns:
        the current PayoutSettings instance, 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

      • 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 -

      • verificationStatus

        public PayoutSettings verificationStatus​(PayoutSettings.VerificationStatusEnum verificationStatus)
        The status of the verification process for the bank account. Possible values: * **valid**: the verification was successful. * **pending**: the verification is in progress. * **invalid**: the information provided is not complete. * **rejected**: there are reasons to refuse working with this entity.
        Parameters:
        verificationStatus -
        Returns:
        the current PayoutSettings instance, allowing for method chaining

      • getVerificationStatus

        public PayoutSettings.VerificationStatusEnum getVerificationStatus()
        The status of the verification process for the bank account. Possible values: * **valid**: the verification was successful. * **pending**: the verification is in progress. * **invalid**: the information provided is not complete. * **rejected**: there are reasons to refuse working with this entity.
        Returns:
        verificationStatus

      • setVerificationStatus

        public void setVerificationStatus​(PayoutSettings.VerificationStatusEnum verificationStatus)
        The status of the verification process for the bank account. Possible values: * **valid**: the verification was successful. * **pending**: the verification is in progress. * **invalid**: the information provided is not complete. * **rejected**: there are reasons to refuse working with this entity.
        Parameters:
        verificationStatus -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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