class Plaid::TransactionBase

A representation of a transaction

Attributes

account_id[RW]

The ID of the account in which this transaction occurred.

account_owner[RW]

This field is not typically populated and only relevant when dealing with sub-accounts. A sub-account most commonly exists in cases where a single account is linked to multiple cards, each with its own card number and card holder name; each card will be considered a sub-account. If the account does have sub-accounts, this field will typically be some combination of the sub-account owner’s name and/or the sub-account mask. The format of this field is not standardized and will vary based on institution.

amount[RW]

The settled value of the transaction, denominated in the transactions’s currency, as stated in ‘iso_currency_code` or `unofficial_currency_code`. For all products except Income: 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. For Income endpoints, values are positive when representing income.

category[RW]

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). All Transactions implementations are recommended to use the new `personal_finance_category` instead of `category`, as it provides greater accuracy and more meaningful categorization. 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.

category_id[RW]

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). All Transactions implementations are recommended to use the new `personal_finance_category` instead of `category`, as it provides greater accuracy and more meaningful categorization. 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.

check_number[RW]

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

date[RW]

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` ). To receive information about the date that a posted transaction was initiated, see the `authorized_date` field.

iso_currency_code[RW]

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

location[RW]
logo_url[RW]

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

merchant_name[RW]

The merchant name, as enriched by Plaid from the ‘name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`.

name[RW]

The merchant name or transaction description. Note: This is a legacy field that is not actively maintained. Use ‘merchant_name` instead for the merchant name. If the `transactions` object was returned by a Transactions endpoint such as `/transactions/sync` or `/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.

original_description[RW]

The string returned by the financial institution to describe the transaction. For transactions returned by ‘/transactions/sync` or `/transactions/get`, this field will only be included if the client has set `options.include_original_description` to `true`.

payment_meta[RW]
pending[RW]

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

pending_transaction_id[RW]

The ID of a posted transaction’s associated pending transaction, where applicable. Not all institutions provide pending transactions.

transaction_id[RW]

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

transaction_type[RW]

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.

unofficial_currency_code[RW]

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.

website[RW]

The website associated with this transaction, if available.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/transaction_base.rb, line 126
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/plaid/models/transaction_base.rb, line 100
def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code',
    :'category' => :'category',
    :'category_id' => :'category_id',
    :'check_number' => :'check_number',
    :'date' => :'date',
    :'location' => :'location',
    :'name' => :'name',
    :'merchant_name' => :'merchant_name',
    :'original_description' => :'original_description',
    :'payment_meta' => :'payment_meta',
    :'pending' => :'pending',
    :'pending_transaction_id' => :'pending_transaction_id',
    :'account_owner' => :'account_owner',
    :'transaction_id' => :'transaction_id',
    :'transaction_type' => :'transaction_type',
    :'logo_url' => :'logo_url',
    :'website' => :'website'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/transaction_base.rb, line 363
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/transaction_base.rb, line 175
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionBase` 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::TransactionBase`. 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?(:'account_id')
    self.account_id = 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?(:'category')
    if (value = attributes[:'category']).is_a?(Array)
      self.category = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'website')
    self.website = attributes[:'website']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/transaction_base.rb, line 157
def self.openapi_nullable
  Set.new([
    :'iso_currency_code',
    :'unofficial_currency_code',
    :'category',
    :'category_id',
    :'check_number',
    :'merchant_name',
    :'original_description',
    :'pending_transaction_id',
    :'account_owner',
    :'logo_url',
    :'website'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/transaction_base.rb, line 131
def self.openapi_types
  {
    :'account_id' => :'String',
    :'amount' => :'Float',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String',
    :'category' => :'Array<String>',
    :'category_id' => :'String',
    :'check_number' => :'String',
    :'date' => :'Date',
    :'location' => :'Location',
    :'name' => :'String',
    :'merchant_name' => :'String',
    :'original_description' => :'String',
    :'payment_meta' => :'PaymentMeta',
    :'pending' => :'Boolean',
    :'pending_transaction_id' => :'String',
    :'account_owner' => :'String',
    :'transaction_id' => :'String',
    :'transaction_type' => :'String',
    :'logo_url' => :'String',
    :'website' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/transaction_base.rb, line 323
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      amount == o.amount &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code &&
      category == o.category &&
      category_id == o.category_id &&
      check_number == o.check_number &&
      date == o.date &&
      location == o.location &&
      name == o.name &&
      merchant_name == o.merchant_name &&
      original_description == o.original_description &&
      payment_meta == o.payment_meta &&
      pending == o.pending &&
      pending_transaction_id == o.pending_transaction_id &&
      account_owner == o.account_owner &&
      transaction_id == o.transaction_id &&
      transaction_type == o.transaction_type &&
      logo_url == o.logo_url &&
      website == o.website
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/plaid/models/transaction_base.rb, line 394
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/plaid/models/transaction_base.rb, line 465
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/transaction_base.rb, line 370
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/transaction_base.rb, line 350
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/transaction_base.rb, line 356
def hash
  [account_id, amount, iso_currency_code, unofficial_currency_code, category, category_id, check_number, date, location, name, merchant_name, original_description, payment_meta, pending, pending_transaction_id, account_owner, transaction_id, transaction_type, logo_url, website].hash
end
list_invalid_properties() click to toggle source

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

# File lib/plaid/models/transaction_base.rb, line 273
def list_invalid_properties
  invalid_properties = Array.new
  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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/transaction_base.rb, line 441
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/transaction_base.rb, line 447
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/transaction_base.rb, line 435
def to_s
  to_hash.to_s
end
transaction_type=(transaction_type) click to toggle source

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

# File lib/plaid/models/transaction_base.rb, line 313
def transaction_type=(transaction_type)
  validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
  unless validator.valid?(transaction_type)
    fail ArgumentError, "invalid value for \"transaction_type\", must be one of #{validator.allowable_values}."
  end
  @transaction_type = transaction_type
end
valid?() click to toggle source

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

# File lib/plaid/models/transaction_base.rb, line 300
def valid?
  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?
  transaction_type_validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
  return false unless transaction_type_validator.valid?(@transaction_type)
  true
end