Plaid.AssetReport.refresh

You're seeing just the function refresh, go back to Plaid.AssetReport module for more information.
Link to this function

refresh(asset_report_token, options \\ %{}, config)

View Source

Specs

refresh(String.t(), options, Plaid.config()) ::
  {:ok, Plaid.AssetReport.AsyncResponse.t()} | {:error, Plaid.Error.t()}
when options: %{
       optional(:client_report_id) => String.t(),
       optional(:days_requested) => non_neg_integer(),
       optional(:webhook) => String.t(),
       optional(:user) => Plaid.AssetReport.User.t()
     }

Create a new, refreshed Asset Report.

Does a POST /asset_report/refresh call to initiate the process of creating a new asset report with refreshed data, based off of a previous one.

Params:

  • asset_report_token - The token for the asset report you want to refresh.

Options:

  • :client_report_id - Client-generated identifier, which can be used by lenders to track loan applications.
  • :days_requested - The days of history to include in the asset report.
  • :webhook - URL Plaid will use to send webhooks for when the asset report is ready.
  • :user - Information about the user to be appended to the asset report. See Plaid.AssetReport.User for available fields.

Each option above acts as an "override" of the original values passed to create/4. Meaning when not specified, values from the original create/4 request will be used.

Examples

AssetReport.refresh("assets-sandbox-123xxx", client_id: "123", secret: "abc")
{:ok, %AssetReport.AsyncResponse{}}