Class UpdatePayoutScheduleRequest


  • public class UpdatePayoutScheduleRequest
    extends Object
    UpdatePayoutScheduleRequest
    • Constructor Detail

      • UpdatePayoutScheduleRequest

        public UpdatePayoutScheduleRequest()
    • Method Detail

      • getAction

        public UpdatePayoutScheduleRequest.ActionEnum getAction()
        Direction on how to handle any payouts that have already been scheduled. Permitted values: * `CLOSE` will close the existing batch of payouts. * `UPDATE` will reschedule the existing batch to the new schedule. * `NOTHING` (**default**) will allow the payout to proceed.
        Returns:
        action
      • getReason

        public String getReason()
        The reason for the payout schedule update. > This field is required when the `schedule` parameter is set to `HOLD`.
        Returns:
        reason
      • setReason

        public void setReason​(String reason)
      • getSchedule

        public UpdatePayoutScheduleRequest.ScheduleEnum getSchedule()
        The payout schedule to which the account is to be updated. Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`. `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.
        Returns:
        schedule
      • equals

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

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

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

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