Struct plaid::model::AssetReportCreateRequestOptions

pub struct AssetReportCreateRequestOptions {
    pub add_ons: Option<Vec<String>>,
    pub client_report_id: Option<String>,
    pub include_fast_report: Option<bool>,
    pub products: Option<Vec<String>>,
    pub user: Option<AssetReportUser>,
    pub webhook: Option<String>,
}

An optional object to filter /asset_report/create results. If provided, must be non-null. The optional user object is required for the report to be eligible for Fannie Mae’s Day 1 Certainty program.

Fields

add_ons: Option<Vec<String>>

Use this field to request a fast_asset report. When Fast Assets is requested, Plaid will create two versions of the Asset Report: first, the Fast Asset Report, which will contain only current identity and balance information, and later, the Full Asset Report, which will also contain historical balance information and transaction data. A PRODUCT_READY webhook will be fired for each Asset Report when it is ready, and the report_type field will indicate whether the webhook is firing for the full or fast Asset Report. To retrieve the Fast Asset Report, call /asset_report/get with fast_report set to true. There is no additional charge for using Fast Assets.

client_report_id: Option<String>

Client-generated identifier, which can be used by lenders to track loan applications.

include_fast_report: Option<bool>

true to return balance and identity earlier as a fast report. Defaults to false if omitted.

products: Option<Vec<String>>

Additional information that can be included in the asset report. Possible values: "investments"

user: Option<AssetReportUser>

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

webhook: Option<String>

URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.

Trait Implementations

impl Clone for AssetReportCreateRequestOptions

fn clone(&self) -> AssetReportCreateRequestOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AssetReportCreateRequestOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AssetReportCreateRequestOptions

fn default() -> AssetReportCreateRequestOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AssetReportCreateRequestOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AssetReportCreateRequestOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for AssetReportCreateRequestOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.