class

Plaid::TransferSweep

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

Describes a sweep of funds to / from the sweep account. A sweep is associated with many sweep events (events of type swept or return_swept) which can be retrieved by invoking the /transfer/event/list endpoint with the corresponding sweep_id. swept events occur when the transfer amount is credited or debited from your sweep account, depending on the type of the transfer. return_swept events occur when a transfer is returned and Plaid undoes the credit or debit. The total sum of the swept and return_swept events is equal to the amount of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, funding_account_id : String | Nil = nil, created : Time | Nil = nil, amount : String | Nil = nil, iso_currency_code : String | Nil = nil, settled : Time | Nil = nil, status : Plaid::SweepStatus | Nil = nil, trigger : Plaid::SweepTrigger | Nil = nil, description : String | Nil = nil, network_trace_id : String | 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

amount

Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00") If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.

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 the sweep occurred, in RFC 3339 format.

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 deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.

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

id

Identifier of the sweep.

Source
id=(new_value : String | Nil)

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

Source
iso_currency_code

The currency of the sweep, 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_trace_id

The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ach or same-day-ach transfers, this is the ACH trace number. Currently, the field will remain null for transfers on other rails.

Source
network_trace_id=(new_value : String | Nil)

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

Source
network_trace_id_present=(network_trace_id_present : Bool)
Source
network_trace_id_present?
Source
settled

The date when the sweep settled, in the YYYY-MM-DD format.

Source
settled=(new_value : Time | Nil)

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

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

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

Source
status_present=(status_present : Bool)
Source
status_present?
Source
trigger
Source
trigger=(new_value : Plaid::SweepTrigger | Nil)

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

Source
trigger_present=(trigger_present : Bool)
Source
trigger_present?
Source
valid?

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

Source