Struct plaid::model::PlaidError

pub struct PlaidError {
    pub causes: Option<Vec<Value>>,
    pub display_message: Option<String>,
    pub documentation_url: Option<String>,
    pub error_code: String,
    pub error_message: String,
    pub error_type: String,
    pub request_id: Option<String>,
    pub status: Option<i64>,
    pub suggested_action: Option<String>,
}

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

Fields

causes: Option<Vec<Value>>

In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.

causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.

display_message: Option<String>

A user-friendly representation of the error code. null if the error is not related to user action.

This may change over time and is not safe for programmatic use.

documentation_url: Option<String>

The URL of a Plaid documentation page with more information about the error

error_code: String

The particular error code. Safe for programmatic use.

error_message: String

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

error_type: String

A broad categorization of the error. Safe for programmatic use.

request_id: Option<String>

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

status: Option<i64>

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

suggested_action: Option<String>

Suggested steps for resolving the error

Trait Implementations

impl Clone for PlaidError

fn clone(&self) -> PlaidError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlaidError

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

Formats the value using the given formatter.

impl Default for PlaidError

fn default() -> PlaidError

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PlaidError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PlaidError

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

Formats the value using the given formatter.

impl Serialize for PlaidError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.