class Plaid::TransferSweep

• Plaid::TransferSweep
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

plaid/models/transfer_sweep.cr

Constructors

• .new(pull : JSON::PullParser)
• .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

Instance Method Summary

• #==(other : self)

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

• #amount : String | Nil
• #amount=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Time | Nil
• #created=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #funding_account_id : String | Nil
• #funding_account_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #iso_currency_code : String | Nil
• #iso_currency_code=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #network_trace_id : String | Nil
• #network_trace_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #network_trace_id_present=(network_trace_id_present : Bool)
• #network_trace_id_present? : Bool
• #settled : Time | Nil
• #settled=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : Plaid::SweepStatus | Nil
• #status=(new_value : Plaid::SweepStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #trigger_present=(trigger_present : Bool)
• #trigger_present? : Bool
• #valid? : Bool

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

Constructor Detail

Instance Method Detail