Package com.adyen.model.configurationwebhooks

Class PlatformPayoutConfigWebhookData

  • public class PlatformPayoutConfigWebhookData
extends Object
    PlatformPayoutConfigWebhookData

    • Constructor Detail

      • PlatformPayoutConfigWebhookData

        public PlatformPayoutConfigWebhookData()

    • Method Detail

      • balancePlatform

        public PlatformPayoutConfigWebhookData balancePlatform​(String balancePlatform)
        The unique identifier of the balance platform.
        Parameters:
        balancePlatform - The unique identifier of the balance platform.
        Returns:
        the current PlatformPayoutConfigWebhookData 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.

      • balancePlatformPayoutScheduleId

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

      • getBalancePlatformPayoutScheduleId

        public String getBalancePlatformPayoutScheduleId()
        The unique identifier of the balance platform payout schedule that is applied to the balance account.
        Returns:
        balancePlatformPayoutScheduleId The unique identifier of the balance platform payout schedule that is applied to the balance account.

      • setBalancePlatformPayoutScheduleId

        public void setBalancePlatformPayoutScheduleId​(String balancePlatformPayoutScheduleId)
        The unique identifier of the balance platform payout schedule that is applied to the balance account.
        Parameters:
        balancePlatformPayoutScheduleId - The unique identifier of the balance platform payout schedule that is applied to the balance account.

      • countryCode

        public PlatformPayoutConfigWebhookData countryCode​(String countryCode)
        The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.
        Parameters:
        countryCode - The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.
        Returns:
        the current PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getCountryCode

        public String getCountryCode()
        The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.
        Returns:
        countryCode The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.

      • setCountryCode

        public void setCountryCode​(String countryCode)
        The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.
        Parameters:
        countryCode - The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.

      • currency

        public PlatformPayoutConfigWebhookData currency​(String currency)
        The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for the payout schedule.
        Parameters:
        currency - The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for the payout schedule.
        Returns:
        the current PlatformPayoutConfigWebhookData 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 the payout schedule.
        Returns:
        currency The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for the payout 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 the payout schedule.
        Parameters:
        currency - The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for the payout schedule.

      • defaultDescription

        public PlatformPayoutConfigWebhookData defaultDescription​(String defaultDescription)
        The default description for payouts initiated by this payout schedule.
        Parameters:
        defaultDescription - The default description for payouts initiated by this payout schedule.
        Returns:
        the current PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getDefaultDescription

        public String getDefaultDescription()
        The default description for payouts initiated by this payout schedule.
        Returns:
        defaultDescription The default description for payouts initiated by this payout schedule.

      • setDefaultDescription

        public void setDefaultDescription​(String defaultDescription)
        The default description for payouts initiated by this payout schedule.
        Parameters:
        defaultDescription - The default description for payouts initiated by this payout schedule.

      • defaultFrequency

        public PlatformPayoutConfigWebhookData defaultFrequency​(String defaultFrequency)
        The default frequency of payouts initiated by this payout schedule.
        Parameters:
        defaultFrequency - The default frequency of payouts initiated by this payout schedule.
        Returns:
        the current PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getDefaultFrequency

        public String getDefaultFrequency()
        The default frequency of payouts initiated by this payout schedule.
        Returns:
        defaultFrequency The default frequency of payouts initiated by this payout schedule.

      • setDefaultFrequency

        public void setDefaultFrequency​(String defaultFrequency)
        The default frequency of payouts initiated by this payout schedule.
        Parameters:
        defaultFrequency - The default frequency of payouts initiated by this payout schedule.

      • defaultFrequencyValue

        public PlatformPayoutConfigWebhookData defaultFrequencyValue​(Integer defaultFrequencyValue)
        The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.
        Parameters:
        defaultFrequencyValue - The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.
        Returns:
        the current PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getDefaultFrequencyValue

        public Integer getDefaultFrequencyValue()
        The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.
        Returns:
        defaultFrequencyValue The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.

      • setDefaultFrequencyValue

        public void setDefaultFrequencyValue​(Integer defaultFrequencyValue)
        The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.
        Parameters:
        defaultFrequencyValue - The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.

      • defaultReference

        public PlatformPayoutConfigWebhookData defaultReference​(String defaultReference)
        Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
        Parameters:
        defaultReference - Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
        Returns:
        the current PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getDefaultReference

        public String getDefaultReference()
        Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
        Returns:
        defaultReference Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.

      • setDefaultReference

        public void setDefaultReference​(String defaultReference)
        Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
        Parameters:
        defaultReference - Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.

      • defaultReferenceForBeneficiary

        public PlatformPayoutConfigWebhookData defaultReferenceForBeneficiary​(String defaultReferenceForBeneficiary)
        The default reference for beneficiary for payouts initiated by this payout schedule.
        Parameters:
        defaultReferenceForBeneficiary - The default reference for beneficiary for payouts initiated by this payout schedule.
        Returns:
        the current PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getDefaultReferenceForBeneficiary

        public String getDefaultReferenceForBeneficiary()
        The default reference for beneficiary for payouts initiated by this payout schedule.
        Returns:
        defaultReferenceForBeneficiary The default reference for beneficiary for payouts initiated by this payout schedule.

      • setDefaultReferenceForBeneficiary

        public void setDefaultReferenceForBeneficiary​(String defaultReferenceForBeneficiary)
        The default reference for beneficiary for payouts initiated by this payout schedule.
        Parameters:
        defaultReferenceForBeneficiary - The default reference for beneficiary for payouts initiated by this payout schedule.

      • maxPayoutAmount

        public PlatformPayoutConfigWebhookData 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 PlatformPayoutConfigWebhookData 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 PlatformPayoutConfigWebhookData 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 PlatformPayoutConfigWebhookData 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.

      • retainedAmount

        public PlatformPayoutConfigWebhookData retainedAmount​(Long retainedAmount)
        The amount of funds that must remain available in a 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 a 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 PlatformPayoutConfigWebhookData instance, allowing for method chaining

      • getRetainedAmount

        public Long getRetainedAmount()
        The amount of funds that must remain available in a 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 a 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 a 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 a 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.

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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