Class: ThePlaidApi::TransferEventType

Inherits:
Object
  • Object
show all
Defined in:
lib/the_plaid_api/models/transfer_event_type.rb

Overview

The type of event that this transfer represents. Event types with prefix ‘sweep` represents events for Plaid Ledger sweeps. `pending`: A new transfer was created; it is in the pending state. `cancelled`: The transfer was cancelled by the client. `failed`: The transfer failed, no funds were moved. `posted`: The transfer has been successfully submitted to the payment network. `settled`: The transfer has been successfully completed by the payment network. `funds_available`: Funds from the transfer have been released from hold and applied to the ledger’s available balance. (Only applicable to ACH debits.) ‘returned`: A posted transfer was returned. `swept`: The transfer was swept to / from the sweep account. `swept_settled`: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account. `return_swept`: Due to the transfer being returned, funds were pulled from or pushed back to the sweep account. `sweep.pending`: A new ledger sweep was created; it is in the pending state. `sweep.posted`: The ledger sweep has been successfully submitted to the payment network. `sweep.settled`: The transaction has settled in the funding account. This means that funds withdrawn from Plaid Ledger balance have reached the funding account, or funds to be deposited into the Plaid Ledger Balance have been pulled, and the hold period has begun. `sweep.returned`: A posted ledger sweep was returned. `sweep.failed`: The ledger sweep failed, no funds were moved. `sweep.funds_available`: Funds from the ledger sweep have been released from hold and applied to the ledger’s available balance. This is only applicable to debits. ‘refund.pending`: A new refund was created; it is in the pending state. `refund.cancelled`: The refund was cancelled. `refund.failed`: The refund failed, no funds were moved. `refund.posted`: The refund has been successfully submitted to the payment network. `refund.settled`: The refund transaction has settled in the Plaid linked account. `refund.returned`: A posted refund was returned. `refund.swept`: The refund was swept from the sweep account. `refund.return_swept`: Due to the refund being returned, funds were pushed back to the sweep account.

Constant Summary collapse

TRANSFER_EVENT_TYPE = 
[
  # TODO: Write general description for PENDING
  PENDING = 'pending'.freeze,

  # TODO: Write general description for CANCELLED
  CANCELLED = 'cancelled'.freeze,

  # TODO: Write general description for FAILED
  FAILED = 'failed'.freeze,

  # TODO: Write general description for POSTED
  POSTED = 'posted'.freeze,

  # TODO: Write general description for SETTLED
  SETTLED = 'settled'.freeze,

  # TODO: Write general description for FUNDS_AVAILABLE
  FUNDS_AVAILABLE = 'funds_available'.freeze,

  # TODO: Write general description for RETURNED
  RETURNED = 'returned'.freeze,

  # TODO: Write general description for SWEPT
  SWEPT = 'swept'.freeze,

  # TODO: Write general description for SWEPT_SETTLED
  SWEPT_SETTLED = 'swept_settled'.freeze,

  # TODO: Write general description for RETURN_SWEPT
  RETURN_SWEPT = 'return_swept'.freeze,

  # TODO: Write general description for ENUM_SWEEPPENDING
  ENUM_SWEEPPENDING = 'sweep.pending'.freeze,

  # TODO: Write general description for ENUM_SWEEPPOSTED
  ENUM_SWEEPPOSTED = 'sweep.posted'.freeze,

  # TODO: Write general description for ENUM_SWEEPSETTLED
  ENUM_SWEEPSETTLED = 'sweep.settled'.freeze,

  # TODO: Write general description for ENUM_SWEEPRETURNED
  ENUM_SWEEPRETURNED = 'sweep.returned'.freeze,

  # TODO: Write general description for ENUM_SWEEPFAILED
  ENUM_SWEEPFAILED = 'sweep.failed'.freeze,

  # TODO: Write general description for ENUM_SWEEPFUNDS_AVAILABLE
  ENUM_SWEEPFUNDS_AVAILABLE = 'sweep.funds_available'.freeze,

  # TODO: Write general description for ENUM_REFUNDPENDING
  ENUM_REFUNDPENDING = 'refund.pending'.freeze,

  # TODO: Write general description for ENUM_REFUNDCANCELLED
  ENUM_REFUNDCANCELLED = 'refund.cancelled'.freeze,

  # TODO: Write general description for ENUM_REFUNDFAILED
  ENUM_REFUNDFAILED = 'refund.failed'.freeze,

  # TODO: Write general description for ENUM_REFUNDPOSTED
  ENUM_REFUNDPOSTED = 'refund.posted'.freeze,

  # TODO: Write general description for ENUM_REFUNDSETTLED
  ENUM_REFUNDSETTLED = 'refund.settled'.freeze,

  # TODO: Write general description for ENUM_REFUNDRETURNED
  ENUM_REFUNDRETURNED = 'refund.returned'.freeze,

  # TODO: Write general description for ENUM_REFUNDSWEPT
  ENUM_REFUNDSWEPT = 'refund.swept'.freeze,

  # TODO: Write general description for ENUM_REFUNDRETURN_SWEPT
  ENUM_REFUNDRETURN_SWEPT = 'refund.return_swept'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = PENDING) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/the_plaid_api/models/transfer_event_type.rb', line 119

def self.from_value(value, default_value = PENDING)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'pending' then PENDING
  when 'cancelled' then CANCELLED
  when 'failed' then FAILED
  when 'posted' then POSTED
  when 'settled' then SETTLED
  when 'funds_available' then FUNDS_AVAILABLE
  when 'returned' then RETURNED
  when 'swept' then SWEPT
  when 'swept_settled' then SWEPT_SETTLED
  when 'return_swept' then RETURN_SWEPT
  when 'enum_sweeppending' then ENUM_SWEEPPENDING
  when 'enum_sweepposted' then ENUM_SWEEPPOSTED
  when 'enum_sweepsettled' then ENUM_SWEEPSETTLED
  when 'enum_sweepreturned' then ENUM_SWEEPRETURNED
  when 'enum_sweepfailed' then ENUM_SWEEPFAILED
  when 'enum_sweepfunds_available' then ENUM_SWEEPFUNDS_AVAILABLE
  when 'enum_refundpending' then ENUM_REFUNDPENDING
  when 'enum_refundcancelled' then ENUM_REFUNDCANCELLED
  when 'enum_refundfailed' then ENUM_REFUNDFAILED
  when 'enum_refundposted' then ENUM_REFUNDPOSTED
  when 'enum_refundsettled' then ENUM_REFUNDSETTLED
  when 'enum_refundreturned' then ENUM_REFUNDRETURNED
  when 'enum_refundswept' then ENUM_REFUNDSWEPT
  when 'enum_refundreturn_swept' then ENUM_REFUNDRETURN_SWEPT
  else
    default_value
  end
end

.validate(value) ⇒ Object 



113
114
115
116
117
 
# File 'lib/the_plaid_api/models/transfer_event_type.rb', line 113

def self.validate(value)
  return false if value.nil?

  TRANSFER_EVENT_TYPE.include?(value)
end