View Source Plaid.Transactions (elixir_plaid v1.2.1)

Plaid Transactions API calls and schema.

Link to this section Summary

Functions

Manually refresh transactions.

Link to this section Functions

Link to this function

get(access_token, start_date, end_date, options \\ %{}, config)

View Source

Specs

get(String.t(), String.t(), String.t(), options, Plaid.config()) ::
  {:ok, Plaid.Transactions.GetResponse.t()} | {:error, Plaid.Error.t()}
when options: %{
       optional(:account_ids) => [String.t()],
       optional(:count) => integer(),
       optional(:offset) => integer()
     }

Get information about transactions.

Does a POST /transactions/get call which gives you high level account data along with transactions from all accounts contained in the access_token's item.

Params:

  • access_token - Token to fetch transactions for.
  • start_date - Start of query for transactions.
  • end_date - End of query for transactions.

Options:

  • :account_ids - Specific account ids to fetch balances for.
  • :count - Amount of transactions to pull.
  • :offset - Offset to start pulling transactions.

example

Example

Transactions.get("access-sandbox-123xxx", "2019-10-10", "2019-10-20", client_id: "123", secret: "abc")
{:ok, %Transactions.GetResponse{}}
Link to this function

refresh(access_token, config)

View Source

Specs

refresh(String.t(), Plaid.config()) ::
  {:ok, Plaid.SimpleResponse.t()} | {:error, Plaid.Error.t()}

Manually refresh transactions.

Does a POST /transactions/refresh call which kicks off a manual transactions extraction for all accounts contained in the access_token's item.

  • access_token - Token to fetch transactions for.

examples

Examples

Transactions.refresh("access-sandbox-123xxx", client_id: "123", secret: "abc") {:ok, %Plaid.SimpleResponse{}}