class

Plaid::RecurringTransfer

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Represents a recurring transfer within the Transfers API.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, recurring_transfer_id : String | Nil = nil, created : Time | Nil = nil, next_origination_date : Time | Nil = nil, _type : Plaid::TransferType | Nil = nil, amount : String | Nil = nil, status : Plaid::TransferRecurringStatus | Nil = nil, network : Plaid::TransferNetwork | Nil = nil, origination_account_id : String | Nil = nil, account_id : String | Nil = nil, funding_account_id : String | Nil = nil, iso_currency_code : String | Nil = nil, description : String | Nil = nil, transfer_ids : Array(String) | Nil = nil, user : TransferUserInResponse | Nil = nil, schedule : Plaid::TransferRecurringSchedule | Nil = nil, test_clock_id : String | Nil = nil, ach_class : Plaid::ACHClass | 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

_type
Source
_type=(new_value : Plaid::TransferType | Nil)

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

Source
account_id

The Plaid account_id corresponding to the end-user account that will be debited or credited.

Source
account_id=(new_value : String | Nil)

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

Source
ach_class
Source
ach_class=(new_value : Plaid::ACHClass | Nil)

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

Source
amount

The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling /transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.

Source
amount=(new_value : String | Nil)

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

Source
created

The datetime when this transfer was created. This will be of the form 2006-01-02T15:04:05Z

Source
created=(new_value : Time | Nil)

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

Source
description

The description of the recurring transfer.

Source
description=(new_value : String | Nil)

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

Source
funding_account_id

The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.

Source
funding_account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] funding_account_id 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

iso_currency_code

The currency of the transfer amount, e.g. "USD"

Source
iso_currency_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] iso_currency_code 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
network
Source
network=(new_value : Plaid::TransferNetwork | Nil)

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

Source
next_origination_date

A date in ISO 8601 format (YYYY-MM-DD). The next transfer origination date after bank holiday adjustment.

Source
next_origination_date=(new_value : Time | Nil)

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

Source
origination_account_id

Plaid’s unique identifier for the origination account that was used for this transfer.

Source
origination_account_id=(new_value : String | Nil)

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

Source
recurring_transfer_id

Plaid’s unique identifier for a recurring transfer.

Source
recurring_transfer_id=(new_value : String | Nil)

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

Source
schedule
Source
schedule=(new_value : Plaid::TransferRecurringSchedule | Nil)

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

Source
status
Source
status=(new_value : Plaid::TransferRecurringStatus | Nil)

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

Source
test_clock_id

Plaid’s unique identifier for a test clock.

Source
test_clock_id=(new_value : String | Nil)

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

Source
test_clock_id_present=(test_clock_id_present : Bool)
Source
test_clock_id_present?
Source
transfer_ids
Source
transfer_ids=(new_value : Array(String) | Nil)

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

Source
user
Source
user=(new_value : TransferUserInResponse | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] user 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