Package com.adyen.model.configurationwebhooks

Class AccountPayoutConfigWebhookData

  • public class AccountPayoutConfigWebhookData
extends Object
    AccountPayoutConfigWebhookData

    • Constructor Detail

      • AccountPayoutConfigWebhookData

        public AccountPayoutConfigWebhookData()

    • Method Detail

      • balanceAccountId

        public AccountPayoutConfigWebhookData balanceAccountId​(String balanceAccountId)
        The unique identifier of the balance account to which the payout schedule was applied.
        Parameters:
        balanceAccountId - The unique identifier of the balance account to which the payout schedule was applied.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getBalanceAccountId

        public String getBalanceAccountId()
        The unique identifier of the balance account to which the payout schedule was applied.
        Returns:
        balanceAccountId The unique identifier of the balance account to which the payout schedule was applied.

      • setBalanceAccountId

        public void setBalanceAccountId​(String balanceAccountId)
        The unique identifier of the balance account to which the payout schedule was applied.
        Parameters:
        balanceAccountId - The unique identifier of the balance account to which the payout schedule was applied.

      • balanceAccountPayoutScheduleId

        public AccountPayoutConfigWebhookData balanceAccountPayoutScheduleId​(String balanceAccountPayoutScheduleId)
        The unique identifier of the balance platform payout schedule that was applied to the balance account.
        Parameters:
        balanceAccountPayoutScheduleId - The unique identifier of the balance platform payout schedule that was applied to the balance account.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getBalanceAccountPayoutScheduleId

        public String getBalanceAccountPayoutScheduleId()
        The unique identifier of the balance platform payout schedule that was applied to the balance account.
        Returns:
        balanceAccountPayoutScheduleId The unique identifier of the balance platform payout schedule that was applied to the balance account.

      • setBalanceAccountPayoutScheduleId

        public void setBalanceAccountPayoutScheduleId​(String balanceAccountPayoutScheduleId)
        The unique identifier of the balance platform payout schedule that was applied to the balance account.
        Parameters:
        balanceAccountPayoutScheduleId - The unique identifier of the balance platform payout schedule that was applied to the balance account.

      • balancePlatform

        public AccountPayoutConfigWebhookData balancePlatform​(String balancePlatform)
        The unique identifier of the balance platform.
        Parameters:
        balancePlatform - The unique identifier of the balance platform.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getBalancePlatform

        public String getBalancePlatform()
        The unique identifier of the balance platform.
        Returns:
        balancePlatform The unique identifier of the balance platform.

      • setBalancePlatform

        public void setBalancePlatform​(String balancePlatform)
        The unique identifier of the balance platform.
        Parameters:
        balancePlatform - The unique identifier of the balance platform.

      • currency

        public AccountPayoutConfigWebhookData currency​(String currency)
        The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.
        Parameters:
        currency - The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getCurrency

        public String getCurrency()
        The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.
        Returns:
        currency The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.

      • setCurrency

        public void setCurrency​(String currency)
        The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.
        Parameters:
        currency - The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.

      • description

        public AccountPayoutConfigWebhookData description​(String description)
        The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.
        Parameters:
        description - The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getDescription

        public String getDescription()
        The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.
        Returns:
        description The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.

      • setDescription

        public void setDescription​(String description)
        The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.
        Parameters:
        description - The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.

      • enabled

        public AccountPayoutConfigWebhookData enabled​(Boolean enabled)
        Specifies whether the payout schedule is active.
        Parameters:
        enabled - Specifies whether the payout schedule is active.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getEnabled

        public Boolean getEnabled()
        Specifies whether the payout schedule is active.
        Returns:
        enabled Specifies whether the payout schedule is active.

      • setEnabled

        public void setEnabled​(Boolean enabled)
        Specifies whether the payout schedule is active.
        Parameters:
        enabled - Specifies whether the payout schedule is active.

      • frequency

        public AccountPayoutConfigWebhookData frequency​(String frequency)
        The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly
        Parameters:
        frequency - The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getFrequency

        public String getFrequency()
        The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly
        Returns:
        frequency The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly

      • setFrequency

        public void setFrequency​(String frequency)
        The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly
        Parameters:
        frequency - The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly

      • frequencyValue

        public AccountPayoutConfigWebhookData frequencyValue​(Integer frequencyValue)
        The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**. Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is **weekly**: **[1 - 5]**.
        Parameters:
        frequencyValue - The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**. Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is **weekly**: **[1 - 5]**.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getFrequencyValue

        public Integer getFrequencyValue()
        The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**. Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is **weekly**: **[1 - 5]**.
        Returns:
        frequencyValue The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**. Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is **weekly**: **[1 - 5]**.

      • setFrequencyValue

        public void setFrequencyValue​(Integer frequencyValue)
        The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**. Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is **weekly**: **[1 - 5]**.
        Parameters:
        frequencyValue - The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**. Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is **weekly**: **[1 - 5]**.

      • maxPayoutAmount

        public AccountPayoutConfigWebhookData maxPayoutAmount​(Long maxPayoutAmount)
        The maximum amount that can be paid out from balance accounts that use this payout schedule.
        Parameters:
        maxPayoutAmount - The maximum amount that can be paid out from balance accounts that use this payout schedule.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getMaxPayoutAmount

        public Long getMaxPayoutAmount()
        The maximum amount that can be paid out from balance accounts that use this payout schedule.
        Returns:
        maxPayoutAmount The maximum amount that can be paid out from balance accounts that use this payout schedule.

      • setMaxPayoutAmount

        public void setMaxPayoutAmount​(Long maxPayoutAmount)
        The maximum amount that can be paid out from balance accounts that use this payout schedule.
        Parameters:
        maxPayoutAmount - The maximum amount that can be paid out from balance accounts that use this payout schedule.

      • minPayoutAmount

        public AccountPayoutConfigWebhookData minPayoutAmount​(Long minPayoutAmount)
        The minimum amount that can be paid out from balance accounts that use this payout schedule.
        Parameters:
        minPayoutAmount - The minimum amount that can be paid out from balance accounts that use this payout schedule.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getMinPayoutAmount

        public Long getMinPayoutAmount()
        The minimum amount that can be paid out from balance accounts that use this payout schedule.
        Returns:
        minPayoutAmount The minimum amount that can be paid out from balance accounts that use this payout schedule.

      • setMinPayoutAmount

        public void setMinPayoutAmount​(Long minPayoutAmount)
        The minimum amount that can be paid out from balance accounts that use this payout schedule.
        Parameters:
        minPayoutAmount - The minimum amount that can be paid out from balance accounts that use this payout schedule.

      • reference

        public AccountPayoutConfigWebhookData reference​(String reference)
        Your internal reference of the payout schedule.
        Parameters:
        reference - Your internal reference of the payout schedule.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getReference

        public String getReference()
        Your internal reference of the payout schedule.
        Returns:
        reference Your internal reference of the payout schedule.

      • setReference

        public void setReference​(String reference)
        Your internal reference of the payout schedule.
        Parameters:
        reference - Your internal reference of the payout schedule.

      • referenceForBeneficiary

        public AccountPayoutConfigWebhookData referenceForBeneficiary​(String referenceForBeneficiary)
        The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.
        Parameters:
        referenceForBeneficiary - The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getReferenceForBeneficiary

        public String getReferenceForBeneficiary()
        The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.
        Returns:
        referenceForBeneficiary The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.

      • setReferenceForBeneficiary

        public void setReferenceForBeneficiary​(String referenceForBeneficiary)
        The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.
        Parameters:
        referenceForBeneficiary - The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.

      • retainedAmount

        public AccountPayoutConfigWebhookData retainedAmount​(Long retainedAmount)
        The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
        Parameters:
        retainedAmount - The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getRetainedAmount

        public Long getRetainedAmount()
        The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
        Returns:
        retainedAmount The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.

      • setRetainedAmount

        public void setRetainedAmount​(Long retainedAmount)
        The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
        Parameters:
        retainedAmount - The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.

      • salesDayClosingTime

        public AccountPayoutConfigWebhookData salesDayClosingTime​(String salesDayClosingTime)
        The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: **HH:mm:SS**
        Parameters:
        salesDayClosingTime - The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: **HH:mm:SS**
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getSalesDayClosingTime

        public String getSalesDayClosingTime()
        The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: **HH:mm:SS**
        Returns:
        salesDayClosingTime The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: **HH:mm:SS**

      • setSalesDayClosingTime

        public void setSalesDayClosingTime​(String salesDayClosingTime)
        The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: **HH:mm:SS**
        Parameters:
        salesDayClosingTime - The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: **HH:mm:SS**

      • transferInstrumentId

        public AccountPayoutConfigWebhookData transferInstrumentId​(String transferInstrumentId)
        The unique identifier of the transfer instrument to which the funds are paid out.
        Parameters:
        transferInstrumentId - The unique identifier of the transfer instrument to which the funds are paid out.
        Returns:
        the current AccountPayoutConfigWebhookData instance, allowing for method chaining

      • getTransferInstrumentId

        public String getTransferInstrumentId()
        The unique identifier of the transfer instrument to which the funds are paid out.
        Returns:
        transferInstrumentId The unique identifier of the transfer instrument to which the funds are paid out.

      • setTransferInstrumentId

        public void setTransferInstrumentId​(String transferInstrumentId)
        The unique identifier of the transfer instrument to which the funds are paid out.
        Parameters:
        transferInstrumentId - The unique identifier of the transfer instrument to which the funds are paid out.

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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