PlaidEx.Schemas.Transaction (plaid_ex v1.0.0)

Copy Markdown View Source

A financial transaction from Plaid's Transactions product.

Includes enriched fields (merchant name, logo, website, category) when using the Transactions product with enrichment enabled.

Summary

Types

t()

@type t() :: %PlaidEx.Schemas.Transaction{
  account_id: String.t(),
  account_owner: String.t() | nil,
  amount: float(),
  authorized_date: String.t() | nil,
  authorized_datetime: String.t() | nil,
  category: [String.t()],
  category_id: String.t() | nil,
  check_number: String.t() | nil,
  counterparties: [map()],
  date: String.t(),
  datetime: String.t() | nil,
  iso_currency_code: String.t() | nil,
  location: map(),
  logo_url: String.t() | nil,
  merchant_entity_id: String.t() | nil,
  merchant_name: String.t() | nil,
  name: String.t(),
  original_description: String.t() | nil,
  payment_channel: String.t() | nil,
  payment_meta: map(),
  pending: boolean(),
  pending_transaction_id: String.t() | nil,
  personal_finance_category: map() | nil,
  personal_finance_category_icon_url: String.t() | nil,
  transaction_code: String.t() | nil,
  transaction_id: String.t(),
  transaction_type: String.t() | nil,
  unofficial_currency_code: String.t() | nil,
  website: String.t() | nil
}

Functions

from_map(map)

@spec from_map(map()) :: t()