class

Plaid::TransferEvent

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

Represents an event in the Transfers API.

Constants

MIN_FOR_EVENT_ID = Int32.new("0")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, event_id : Int32 | Nil = nil, timestamp : Time | Nil = nil, event_type : Plaid::TransferEventType | Nil = nil, funding_account_id : String | Nil = nil, transfer_id : String | Nil = nil, origination_account_id : String | Nil = nil, failure_reason : TransferFailure | Nil = nil, sweep_id : String | Nil = nil, sweep_amount : String | Nil = nil, refund_id : String | Nil = nil, originator_client_id : String | Nil = nil, account_id : String | Nil = nil, transfer_type : Plaid::OmittableTransferType | Nil = nil, transfer_amount : 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

account_id

The account ID associated with the transfer. This field is omitted for Plaid Ledger Sweep events.

Source
account_id=(new_value : String | Nil)

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

Source
event_id

Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.

Source
event_id=(new_value : Int32 | Nil)

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

Source
event_type
Source
event_type=(new_value : Plaid::TransferEventType | Nil)

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

Source
failure_reason
Source
failure_reason=(new_value : TransferFailure | Nil)

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

Source
funding_account_id

The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates 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

list_invalid_properties

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

Source
origination_account_id

The ID of the origination account that this balance belongs to.

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
originator_client_id

The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).

Source
originator_client_id=(new_value : String | Nil)

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

Source
refund_id

Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.

Source
refund_id=(new_value : String | Nil)

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

Source
sweep_amount

A signed amount of how much was swept or return_swept for this transfer (decimal string with two digits of precision e.g. "-5.50").

Source
sweep_amount=(new_value : String | Nil)

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

Source
sweep_id

Plaid’s unique identifier for a sweep.

Source
sweep_id=(new_value : String | Nil)

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

Source
timestamp

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

Source
timestamp=(new_value : Time | Nil)

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

Source
transfer_amount

The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). This field is omitted for Plaid Ledger Sweep events.

Source
transfer_amount=(new_value : String | Nil)

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

Source
transfer_id

Plaid’s unique identifier for a transfer. This field is null for Plaid Ledger Sweep events.

Source
transfer_id=(new_value : String | Nil)

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

Source
transfer_type
Source
transfer_type=(new_value : Plaid::OmittableTransferType | Nil)

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