Tink.Enrichment.Transactions (Tink v1.0.0)

Copy Markdown View Source

Enriched transaction data with categories, merchant info, and COâ‚‚. Requires enrichment.transactions:readonly or transactions:read.

Summary

Functions

Find enriched transactions similar to a given transaction.

List enriched transactions.

Fetch enriched transactions by a list of IDs.

Stream all enriched transactions lazily.

Submit categorization feedback. Requires enrichment.transactions.

Functions

find_similar(client, transaction_id, opts \\ [])

@spec find_similar(Tink.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Find enriched transactions similar to a given transaction.

list(client, opts \\ [])

@spec list(
  Tink.Client.t(),
  keyword()
) :: {:ok, map()} | {:error, Tink.Error.t()}

List enriched transactions.

Options

  • :page_token, :date_gte, :date_lte, :account_id_in
  • :page_size — defaults to 10; up to 100 transactions per request

list_by_ids(client, ids)

@spec list_by_ids(Tink.Client.t(), [String.t()]) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Fetch enriched transactions by a list of IDs.

stream(client, opts \\ [])

@spec stream(
  Tink.Client.t(),
  keyword()
) :: Enumerable.t()

Stream all enriched transactions lazily.

submit_feedback(client, feedback)

@spec submit_feedback(Tink.Client.t(), map()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Submit categorization feedback. Requires enrichment.transactions.