Package com.plaid.client.model

Class ExternalPaymentScheduleBase

java.lang.Object
com.plaid.client.model.ExternalPaymentScheduleBase
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-08-13T23:02:46.991Z[GMT]")
public class ExternalPaymentScheduleBase
extends java.lang.Object
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.

  • Field Details

    • SERIALIZED_NAME_INTERVAL

      public static final java.lang.String SERIALIZED_NAME_INTERVAL
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_INTERVAL_EXECUTION_DAY

      public static final java.lang.String SERIALIZED_NAME_INTERVAL_EXECUTION_DAY
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_START_DATE

      public static final java.lang.String SERIALIZED_NAME_START_DATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_END_DATE

      public static final java.lang.String SERIALIZED_NAME_END_DATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_ADJUSTED_START_DATE

      public static final java.lang.String SERIALIZED_NAME_ADJUSTED_START_DATE
      See Also:
      Constant Field Values

  • Constructor Details

    • ExternalPaymentScheduleBase

      public ExternalPaymentScheduleBase()

  • Method Details

    • interval

      public ExternalPaymentScheduleBase interval​(PaymentScheduleInterval interval)

    • getInterval

      @Nullable public PaymentScheduleInterval getInterval()
      Get interval
      Returns:
      interval

    • setInterval

      public void setInterval​(PaymentScheduleInterval interval)

    • intervalExecutionDay

      public ExternalPaymentScheduleBase intervalExecutionDay​(java.lang.Integer intervalExecutionDay)

    • getIntervalExecutionDay

      @Nullable public java.lang.Integer getIntervalExecutionDay()
      The day of the interval on which to schedule the payment. If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday). If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.
      Returns:
      intervalExecutionDay

    • setIntervalExecutionDay

      public void setIntervalExecutionDay​(java.lang.Integer intervalExecutionDay)

    • startDate

      public ExternalPaymentScheduleBase startDate​(java.time.LocalDate startDate)

    • getStartDate

      @Nullable public java.time.LocalDate getStartDate()
      A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`. If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
      Returns:
      startDate

    • setStartDate

      public void setStartDate​(java.time.LocalDate startDate)

    • endDate

      public ExternalPaymentScheduleBase endDate​(java.time.LocalDate endDate)

    • getEndDate

      @Nullable public java.time.LocalDate getEndDate()
      A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
      Returns:
      endDate

    • setEndDate

      public void setEndDate​(java.time.LocalDate endDate)

    • adjustedStartDate

      public ExternalPaymentScheduleBase adjustedStartDate​(java.time.LocalDate adjustedStartDate)

    • getAdjustedStartDate

      @Nullable public java.time.LocalDate getAdjustedStartDate()
      The start date sent to the bank after adjusting for holidays or weekends. Will be provided in ISO 8601 format (YYYY-MM-DD). If the start date did not require adjustment, this field will be `null`.
      Returns:
      adjustedStartDate

    • setAdjustedStartDate

      public void setAdjustedStartDate​(java.time.LocalDate adjustedStartDate)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object