plaid v2.1.0 Plaid.Investments.Transactions View Source

Functions for Plaid investments/transactions endpoints.

Link to this section Summary

Types

config()

params()

t()

Functions

get(params, config \\ %{})

Gets user-authorized transaction data for investment accounts

Link to this section Types

config()

config() :: %{required(atom()) => String.t()}

params()

params() :: %{required(atom()) => String.t() | map()}

t()

t() :: %Plaid.Investments.Transactions{
  accounts: [Plaid.Accounts.Account.t()],
  investment_transactions: [Plaid.Investments.Transactions.Transaction.t()],
  item: Plaid.Item.t(),
  request_id: String.t(),
  securities: [Plaid.Investments.Security.t()],
  total_investment_transactions: integer()
}

Link to this section Functions

get(params, config \\ %{})

get(params(), config() | nil) ::
  {:ok, Plaid.Investments.Tansactions.t()} | {:error, Plaid.Error.t()}

Gets user-authorized transaction data for investment accounts

Parameters

 %{
  access_token: "access-env-identifier",
  start_date: "2017-01-01",
  end_date: "2017-03-31",
  options: %{
    account_ids: ["BFEWTGFD"],
    count: 20,
    offset: 0
  }
}