plaid v1.8.0 Plaid.Transactions View Source

Functions for Plaid transactions endpoint.

Link to this section Summary

Functions

Gets transactions data associated with an Item.

Link to this section Types

Link to this type

config()

View Source
config() :: %{required(atom()) => String.t()}
Link to this type

params()

View Source
params() :: %{required(atom()) => String.t() | map()}
Link to this type

t()

View Source
t() :: %Plaid.Transactions{
  accounts: [Plaid.Accounts.Account.t()],
  item: Plaid.Item.t(),
  request_id: String.t(),
  total_transactions: integer(),
  transactions: [Plaid.Transactions.Transaction.t()]
}

Link to this section Functions

Link to this function

get(params, config \\ %{})

View Source
get(params(), config() | nil) ::
  {:ok, Plaid.Transactions.t()} | {:error, Plaid.Error.t()}

Gets transactions data associated with an Item.

Parameters

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