class

Plaid::TransactionBase

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

A representation of a transaction

Constants

ERROR_MESSAGE_FOR_TRANSACTION_TYPE = "invalid value for \"transaction_type\", must be one of [digital, place, special, unresolved]."
VALID_VALUES_FOR_TRANSACTION_TYPE = String.static_array("digital", "place", "special", "unresolved")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_id : String | Nil = nil, amount : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, unofficial_currency_code : String | Nil = nil, date : Time | Nil = nil, pending : Bool | Nil = nil, transaction_id : String | Nil = nil, category : Array(String) | Nil = nil, category_id : String | Nil = nil, check_number : String | Nil = nil, location : Location | Nil = nil, name : String | Nil = nil, merchant_name : String | Nil = nil, original_description : String | Nil = nil, payment_meta : PaymentMeta | Nil = nil, pending_transaction_id : String | Nil = nil, account_owner : String | Nil = nil, transaction_type : String | Nil = nil, logo_url : String | Nil = nil, website : 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 ID of the account in which this transaction occurred.

Source
account_id=(new_value : String | Nil)

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

Source
account_owner

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

Source
account_owner=(new_value : String | Nil)

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

Source
account_owner_present=(account_owner_present : Bool)
Source
account_owner_present?
Source
amount

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.

Source
amount=(new_value : Float64 | Nil)

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

Source
category

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get. 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.

Source
category=(new_value : Array(String) | Nil)

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

Source
category_id

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get. 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.

Source
category_id=(new_value : String | Nil)

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

Source
category_id_present=(category_id_present : Bool)
Source
category_id_present?
Source
category_present=(category_present : Bool)
Source
category_present?
Source
check_number

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

Source
check_number=(new_value : String | Nil)

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

Source
check_number_present=(check_number_present : Bool)
Source
check_number_present?
Source
date

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

Source
date=(new_value : Time | Nil)

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

iso_currency_code

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

Source
iso_currency_code=(new_value : String | Nil)

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

Source
list_invalid_properties

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

Source
location
Source
location=(new_value : Location | Nil)

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

Source
logo_url

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

Source
logo_url=(new_value : String | Nil)

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

Source
logo_url_present=(logo_url_present : Bool)
Source
logo_url_present?
Source
merchant_name

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.

Source
merchant_name=(new_value : String | Nil)

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

Source
merchant_name_present=(merchant_name_present : Bool)
Source
merchant_name_present?
Source
name

The merchant name or transaction description. 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.

Source
name=(new_value : String | Nil)

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

Source
original_description

The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/sync or /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.

Source
original_description=(new_value : String | Nil)

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

Source
original_description_present=(original_description_present : Bool)
Source
original_description_present?
Source
payment_meta
Source
payment_meta=(new_value : PaymentMeta | Nil)

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

Source
pending

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

Source
pending=(new_value : Bool | Nil)

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

Source
pending_transaction_id

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

Source
pending_transaction_id=(new_value : String | Nil)

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

Source
pending_transaction_id_present=(pending_transaction_id_present : Bool)
Source
pending_transaction_id_present?
Source
transaction_id

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

Source
transaction_id=(new_value : String | Nil)

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

Source
transaction_type

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.

Source
transaction_type=(new_value : String | Nil)

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

Source
unofficial_currency_code

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 for a full listing of supported iso_currency_codes.

Source
unofficial_currency_code=(new_value : String | Nil)

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

The website associated with this transaction, if available.

Source
website=(new_value : String | Nil)

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

Source
website_present=(website_present : Bool)
Source
website_present?
Source