plaid
plaid

View Source Plaid.Transactions (plaid v3.3.0)

Functions for Plaid transactions endpoint.

Link to this section Summary

Types

config()
error()
params()
t()

Functions

get(params, config \\ %{})

Gets transactions data associated with an Item.

sync(params, config \\ %{})

Sync transactions data associated with an Item.

Link to this section Types

Link to this type

config()

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

error()

View Source 
@type error() :: {:error, Plaid.Error.t() | any()} | no_return()
Link to this type

params()

View Source 
@type params() :: %{required(atom()) => term()}
Link to this type

t()

View Source 
@type 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 
@spec get(params(), config()) :: {:ok, t()} | error()

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
  }
}
Link to this function

sync(params, config \\ %{})

View Source 
@spec sync(params(), config()) :: {:ok, Plaid.Transactions.Sync.t()} | error()

Sync transactions data associated with an Item.

Parameters

%{
  access_token: "access-env-identifier",
  count: 20,
  cursor: "last-request-cursor-value"
}