class

Plaid::TransactionCounterparty

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

The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, name : String | Nil = nil, _type : Plaid::CounterpartyType | Nil = nil, website : String | Nil = nil, logo_url : String | Nil = nil, entity_id : String | Nil = nil, confidence_level : 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

_type
Source
_type=(new_value : Plaid::CounterpartyType | Nil)

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

Source
confidence_level

A description of how confident we are that the provided counterparty is involved in the transaction. VERY_HIGH: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. HIGH: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. MEDIUM: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. LOW: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. UNKNOWN: We don’t know the confidence level for this counterparty.

Source
confidence_level=(new_value : String | Nil)

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

Source
confidence_level_present=(confidence_level_present : Bool)
Source
confidence_level_present?
Source
entity_id

A unique, stable, Plaid-generated ID that maps to the counterparty.

Source
entity_id=(new_value : String | Nil)

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

Source
entity_id_present=(entity_id_present : Bool)
Source
entity_id_present?
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

list_invalid_properties

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

Source
logo_url

The URL of a logo associated with the counterparty, 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
name

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

Source
name=(new_value : String | Nil)

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

Source
website=(new_value : String | Nil)

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

Source