PlaidEx.Schemas.Account (plaid_ex v1.0.0)

Copy Markdown View Source

A financial account returned by Plaid.

Covers both depository accounts (checking, savings) and credit, investment, loan, and other account types.

Summary

Types

account_subtype()

@type account_subtype() ::
  :checking
  | :savings
  | :cd
  | :money_market
  | :paypal
  | :prepaid
  | :credit_card
  | :auto
  | :commercial
  | :construction
  | :consumer
  | :home_equity
  | :line_of_credit
  | :loan
  | :mortgage
  | :overdraft
  | :student
  | :"401a"
  | :"401k"
  | :"403b"
  | :"457b"
  | :"529"
  | :brokerage
  | :cash_isa
  | :education_savings_account
  | :fixed_annuity
  | :gic
  | :health_reimbursement_arrangement
  | :hsa
  | :isa
  | :ira
  | :lif
  | :life_insurance
  | :lira
  | :lrif
  | :lrsp
  | :mutual_fund
  | :non_custodial_wallet
  | :non_taxable_brokerage_account
  | :other_annuity
  | :other_insurance
  | :pension
  | :prif
  | :profit_sharing_plan
  | :rdsp
  | :resp
  | :rlif
  | :rrif
  | :rrsp
  | :sarsep
  | :sep_ira
  | :simple_ira
  | :sipp
  | :stock_plan
  | :thrift_savings_plan
  | :tfsa
  | :ugma
  | :utma
  | :variable_annuity

account_type()

@type account_type() :: :depository | :credit | :loan | :investment | :other

t()

@type t() :: %PlaidEx.Schemas.Account{
  account_id: String.t(),
  balances: map(),
  mask: String.t() | nil,
  name: String.t(),
  official_name: String.t() | nil,
  persistent_account_id: String.t() | nil,
  subtype: account_subtype() | nil,
  type: account_type(),
  verification_status: String.t() | nil
}

Functions

from_map(map)

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