Plaid.AssetReport.create

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

create(access_tokens, days_requested, options \\ %{}, config)

View Source

Specs

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

Create an Asset Report.

Does a POST /asset_report/create call to initiate the process of creating an asset report.

Params:

  • access_tokens - List of tokens coresponding to the items that will be included in the report.
  • days_requested - The days of history to include in the asset report.

Options:

  • :client_report_id - Client-generated identifier, which can be used by lenders to track loan applications.
  • :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.

Examples

AssetReport.create(["access-sandbox-123xxx"], 3, client_id: "123", secret: "abc")
{:ok, %AssetReport.AsyncResponse{}}