class

Plaid::ExternalPaymentScheduleGet

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < 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.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, interval : Plaid::PaymentScheduleInterval | Nil = nil, interval_execution_day : Int32 | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, adjusted_start_date : Time | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

adjusted_start_date

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.

Source
adjusted_start_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] adjusted_start_date Object to be assigned

Source
end_date

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.

Source
end_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] end_date Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

interval
Source
interval=(new_value : Plaid::PaymentScheduleInterval | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interval Object to be assigned

Source
interval_execution_day

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.

Source
interval_execution_day=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interval_execution_day Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
start_date

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.

Source
start_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] start_date Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source