Class: Plaid::Transaction

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transaction.rb

Overview

A representation of a transaction

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/plaid/models/transaction.rb', line 204

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Transaction` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::Transaction`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'transaction_type')
    self.transaction_type = attributes[:'transaction_type']
  end

  if attributes.key?(:'pending_transaction_id')
    self.pending_transaction_id = attributes[:'pending_transaction_id']
  end

  if attributes.key?(:'category_id')
    self.category_id = attributes[:'category_id']
  end

  if attributes.key?(:'category')
    if (value = attributes[:'category']).is_a?(Array)
      self.category = value
    end
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  end

  if attributes.key?(:'payment_meta')
    self.payment_meta = attributes[:'payment_meta']
  end

  if attributes.key?(:'account_owner')
    self. = attributes[:'account_owner']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'original_description')
    self.original_description = attributes[:'original_description']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'iso_currency_code')
    self.iso_currency_code = attributes[:'iso_currency_code']
  end

  if attributes.key?(:'unofficial_currency_code')
    self.unofficial_currency_code = attributes[:'unofficial_currency_code']
  end

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.key?(:'pending')
    self.pending = attributes[:'pending']
  end

  if attributes.key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.key?(:'merchant_name')
    self.merchant_name = attributes[:'merchant_name']
  end

  if attributes.key?(:'check_number')
    self.check_number = attributes[:'check_number']
  end

  if attributes.key?(:'payment_channel')
    self.payment_channel = attributes[:'payment_channel']
  end

  if attributes.key?(:'authorized_date')
    self.authorized_date = attributes[:'authorized_date']
  end

  if attributes.key?(:'authorized_datetime')
    self.authorized_datetime = attributes[:'authorized_datetime']
  end

  if attributes.key?(:'datetime')
    self.datetime = attributes[:'datetime']
  end

  if attributes.key?(:'transaction_code')
    self.transaction_code = attributes[:'transaction_code']
  end

  if attributes.key?(:'personal_finance_category')
    self.personal_finance_category = attributes[:'personal_finance_category']
  end
end

Instance Attribute Details

#account_id ⇒ Object

The ID of the account in which this transaction occurred.



45
46
47
 
# File 'lib/plaid/models/transaction.rb', line 45

def 
  @account_id
end

#account_owner ⇒ Object

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.



36
37
38
 
# File 'lib/plaid/models/transaction.rb', line 36

def 
  @account_owner
end

#amount ⇒ Object

The settled value of the transaction, denominated in the transactions’s currency, as stated in ‘iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.



48
49
50
 
# File 'lib/plaid/models/transaction.rb', line 48

def amount
  @amount
end

#authorized_date ⇒ Object

The date that the transaction was authorized. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DD` ).



75
76
77
 
# File 'lib/plaid/models/transaction.rb', line 75

def authorized_date
  @authorized_date
end

#authorized_datetime ⇒ Object

Date and time when a transaction was authorized in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DDTHH:mm:ssZ` ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).



78
79
80
 
# File 'lib/plaid/models/transaction.rb', line 78

def authorized_datetime
  @authorized_datetime
end

#category ⇒ Object

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.



29
30
31
 
# File 'lib/plaid/models/transaction.rb', line 29

def category
  @category
end

#category_id ⇒ Object

The ID of the category to which this transaction belongs. For a full list of categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.



26
27
28
 
# File 'lib/plaid/models/transaction.rb', line 26

def category_id
  @category_id
end

#check_number ⇒ Object

The check number of the transaction. This field is only populated for check transactions.



69
70
71
 
# File 'lib/plaid/models/transaction.rb', line 69

def check_number
  @check_number
end

#date ⇒ Object

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DD` ).



57
58
59
 
# File 'lib/plaid/models/transaction.rb', line 57

def date
  @date
end

#datetime ⇒ Object

Date and time when a transaction was posted in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DDTHH:mm:ssZ` ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).



81
82
83
 
# File 'lib/plaid/models/transaction.rb', line 81

def datetime
  @datetime
end

#iso_currency_code ⇒ Object

The ISO-4217 currency code of the transaction. Always ‘null` if `unofficial_currency_code` is non-null.



51
52
53
 
# File 'lib/plaid/models/transaction.rb', line 51

def iso_currency_code
  @iso_currency_code
end

#location ⇒ Object

Returns the value of attribute location.



31
32
33
 
# File 'lib/plaid/models/transaction.rb', line 31

def location
  @location
end

#merchant_name ⇒ Object

The merchant name, as extracted by Plaid from the ‘name` field.



66
67
68
 
# File 'lib/plaid/models/transaction.rb', line 66

def merchant_name
  @merchant_name
end

#name ⇒ Object

The merchant name or transaction description. If the ‘transactions` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.



39
40
41
 
# File 'lib/plaid/models/transaction.rb', line 39

def name
  @name
end

#original_description ⇒ Object

The string returned by the financial institution to describe the transaction. For transactions returned by ‘/transactions/get`, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set `options.include_original_description` to `true`.



42
43
44
 
# File 'lib/plaid/models/transaction.rb', line 42

def original_description
  @original_description
end

#payment_channel ⇒ Object

The channel used to make a payment. ‘online:` transactions that took place online. `in store:` transactions that were made at a physical location. `other:` transactions that relate to banks, e.g. fees or deposits. This field replaces the `transaction_type` field.



72
73
74
 
# File 'lib/plaid/models/transaction.rb', line 72

def payment_channel
  @payment_channel
end

#payment_meta ⇒ Object

Returns the value of attribute payment_meta.



33
34
35
 
# File 'lib/plaid/models/transaction.rb', line 33

def payment_meta
  @payment_meta
end

#pending ⇒ Object

When ‘true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.



60
61
62
 
# File 'lib/plaid/models/transaction.rb', line 60

def pending
  @pending
end

#pending_transaction_id ⇒ Object

The ID of a posted transaction’s associated pending transaction, where applicable.



23
24
25
 
# File 'lib/plaid/models/transaction.rb', line 23

def pending_transaction_id
  @pending_transaction_id
end

#personal_finance_category ⇒ Object

Returns the value of attribute personal_finance_category.



85
86
87
 
# File 'lib/plaid/models/transaction.rb', line 85

def personal_finance_category
  @personal_finance_category
end

#transaction_code ⇒ Object

Returns the value of attribute transaction_code.



83
84
85
 
# File 'lib/plaid/models/transaction.rb', line 83

def transaction_code
  @transaction_code
end

#transaction_id ⇒ Object

The unique ID of the transaction. Like all Plaid identifiers, the ‘transaction_id` is case sensitive.



63
64
65
 
# File 'lib/plaid/models/transaction.rb', line 63

def transaction_id
  @transaction_id
end

#transaction_type ⇒ Object

Please use the ‘payment_channel` field, `transaction_type` will be deprecated in the future. `digital:` transactions that took place online. `place:` transactions that were made at a physical location. `special:` transactions that relate to banks, e.g. fees or deposits. `unresolved:` transactions that do not fit into the other three types.



20
21
22
 
# File 'lib/plaid/models/transaction.rb', line 20

def transaction_type
  @transaction_type
end

#unofficial_currency_code ⇒ Object

The unofficial currency code associated with the transaction. Always ‘null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.



54
55
56
 
# File 'lib/plaid/models/transaction.rb', line 54

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



140
141
142
 
# File 'lib/plaid/models/transaction.rb', line 140

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/plaid/models/transaction.rb', line 110

def self.attribute_map
  {
    :'transaction_type' => :'transaction_type',
    :'pending_transaction_id' => :'pending_transaction_id',
    :'category_id' => :'category_id',
    :'category' => :'category',
    :'location' => :'location',
    :'payment_meta' => :'payment_meta',
    :'account_owner' => :'account_owner',
    :'name' => :'name',
    :'original_description' => :'original_description',
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code',
    :'date' => :'date',
    :'pending' => :'pending',
    :'transaction_id' => :'transaction_id',
    :'merchant_name' => :'merchant_name',
    :'check_number' => :'check_number',
    :'payment_channel' => :'payment_channel',
    :'authorized_date' => :'authorized_date',
    :'authorized_datetime' => :'authorized_datetime',
    :'datetime' => :'datetime',
    :'transaction_code' => :'transaction_code',
    :'personal_finance_category' => :'personal_finance_category'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



444
445
446
 
# File 'lib/plaid/models/transaction.rb', line 444

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



195
196
197
198
199
200
 
# File 'lib/plaid/models/transaction.rb', line 195

def self.openapi_all_of
  [
  :'TransactionAllOf',
  :'TransactionBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/plaid/models/transaction.rb', line 175

def self.openapi_nullable
  Set.new([
    :'pending_transaction_id',
    :'category_id',
    :'category',
    :'account_owner',
    :'original_description',
    :'iso_currency_code',
    :'unofficial_currency_code',
    :'merchant_name',
    :'check_number',
    :'authorized_date',
    :'authorized_datetime',
    :'datetime',
    :'transaction_code',
    :'personal_finance_category'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/plaid/models/transaction.rb', line 145

def self.openapi_types
  {
    :'transaction_type' => :'String',
    :'pending_transaction_id' => :'String',
    :'category_id' => :'String',
    :'category' => :'Array<String>',
    :'location' => :'Location',
    :'payment_meta' => :'PaymentMeta',
    :'account_owner' => :'String',
    :'name' => :'String',
    :'original_description' => :'String',
    :'account_id' => :'String',
    :'amount' => :'Float',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String',
    :'date' => :'Date',
    :'pending' => :'Boolean',
    :'transaction_id' => :'String',
    :'merchant_name' => :'String',
    :'check_number' => :'String',
    :'payment_channel' => :'String',
    :'authorized_date' => :'Date',
    :'authorized_datetime' => :'Time',
    :'datetime' => :'Time',
    :'transaction_code' => :'TransactionCode',
    :'personal_finance_category' => :'PersonalFinanceCategory'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/plaid/models/transaction.rb', line 400

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_type == o.transaction_type &&
      pending_transaction_id == o.pending_transaction_id &&
      category_id == o.category_id &&
      category == o.category &&
      location == o.location &&
      payment_meta == o.payment_meta &&
       == o. &&
      name == o.name &&
      original_description == o.original_description &&
       == o. &&
      amount == o.amount &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code &&
      date == o.date &&
      pending == o.pending &&
      transaction_id == o.transaction_id &&
      merchant_name == o.merchant_name &&
      check_number == o.check_number &&
      payment_channel == o.payment_channel &&
      authorized_date == o.authorized_date &&
      authorized_datetime == o.authorized_datetime &&
      datetime == o.datetime &&
      transaction_code == o.transaction_code &&
      personal_finance_category == o.personal_finance_category
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/plaid/models/transaction.rb', line 474

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/plaid/models/transaction.rb', line 545

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/plaid/models/transaction.rb', line 451

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


431
432
433
 
# File 'lib/plaid/models/transaction.rb', line 431

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



437
438
439
 
# File 'lib/plaid/models/transaction.rb', line 437

def hash
  [transaction_type, pending_transaction_id, category_id, category, location, payment_meta, , name, original_description, , amount, iso_currency_code, unofficial_currency_code, date, pending, transaction_id, merchant_name, check_number, payment_channel, authorized_date, authorized_datetime, datetime, transaction_code, personal_finance_category].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/plaid/models/transaction.rb', line 318

def list_invalid_properties
  invalid_properties = Array.new
  if @location.nil?
    invalid_properties.push('invalid value for "location", location cannot be nil.')
  end

  if @payment_meta.nil?
    invalid_properties.push('invalid value for "payment_meta", payment_meta cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  if @pending.nil?
    invalid_properties.push('invalid value for "pending", pending cannot be nil.')
  end

  if @transaction_id.nil?
    invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.')
  end

  if @payment_channel.nil?
    invalid_properties.push('invalid value for "payment_channel", payment_channel cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



521
522
523
 
# File 'lib/plaid/models/transaction.rb', line 521

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/plaid/models/transaction.rb', line 527

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



515
516
517
 
# File 'lib/plaid/models/transaction.rb', line 515

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/plaid/models/transaction.rb', line 361

def valid?
  transaction_type_validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
  return false unless transaction_type_validator.valid?(@transaction_type)
  return false if @location.nil?
  return false if @payment_meta.nil?
  return false if @name.nil?
  return false if @account_id.nil?
  return false if @amount.nil?
  return false if @date.nil?
  return false if @pending.nil?
  return false if @transaction_id.nil?
  return false if @payment_channel.nil?
  payment_channel_validator = EnumAttributeValidator.new('String', ["online", "in store", "other"])
  return false unless payment_channel_validator.valid?(@payment_channel)
  true
end