class

Plaid::ClientProvidedTransaction

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

A client-provided transaction for Plaid to enrich.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, description : String | Nil = nil, amount : Float64 | Nil = nil, direction : Plaid::EnrichTransactionDirection | Nil = nil, iso_currency_code : String | Nil = nil, client_user_id : String | Nil = nil, client_account_id : String | Nil = nil, account_type : String | Nil = nil, account_subtype : String | Nil = nil, location : ClientProvidedTransactionLocation | Nil = nil, mcc : String | Nil = nil, date_posted : Time | 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_subtype

The account subtype associated with the transaction. For a full list of valid types and subtypes, see the Account schema.

Source
account_subtype=(new_value : String | Nil)

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

Source
account_type

The account type associated with the transaction. For a full list of valid types and subtypes, see the Account schema.

Source
account_type=(new_value : String | Nil)

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

Source
amount

The absolute value of the transaction (>= 0). When testing Enrich, note that amount data should be realistic. Unrealistic or inaccurate amount data may result in reduced quality output.

Source
amount=(new_value : Float64 | Nil)

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

Source
client_account_id

A unique account id used to group transactions for a given account, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_account_id.

Source
client_account_id=(new_value : String | Nil)

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

Source
client_user_id

A unique user id used to group transactions for a given user, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

Source
client_user_id=(new_value : String | Nil)

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

Source
date_posted

The date the transaction posted, in ISO 8601 (YYYY-MM-DD) format.

Source
date_posted=(new_value : Time | Nil)

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

Source
description

The raw description of the transaction. If you have location data in available an unstructured format, it may be appended to the description field.

Source
description=(new_value : String | Nil)

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

Source
direction
Source
direction=(new_value : Plaid::EnrichTransactionDirection | Nil)

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

id

A unique ID for the transaction used to help you tie data back to your systems.

Source
id=(new_value : String | Nil)

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

Source
iso_currency_code

The ISO-4217 currency code of the transaction e.g. USD.

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 : ClientProvidedTransactionLocation | Nil)

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

Source
mcc

Merchant category codes (MCCs) are four-digit numbers that describe a merchant's primary business activities.

Source
mcc=(new_value : String | Nil)

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