PlaidEx.API.Statements (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Statements API — retrieve bank statements.

Summary

Functions

download(config, access_token, statement_id, opts \\ [])

Downloads a statement PDF.

list(config, access_token, opts \\ [])

Lists available statements for an Item.

refresh(config, value, opts \\ [])

Refreshes statements data for an Item.

Functions

download(config, access_token, statement_id, opts \\ [])

@spec download(PlaidEx.Config.t(), String.t(), String.t(), keyword()) ::
  {:ok, binary()} | {:error, PlaidEx.Error.t()}

Downloads a statement PDF.

list(config, access_token, opts \\ [])

@spec list(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Lists available statements for an Item.

refresh(config, value, opts \\ [])

@spec refresh(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Refreshes statements data for an Item.