plaid2.model.error module
- class plaid2.model.error.Error(*, status: Optional[float] = None, causes: Optional[List[Any]] = None, display_message: Optional[str] = None, error_type: str, request_id: Optional[str] = None, documentation_url: Optional[str] = None, error_code: str, error_message: str, suggested_action: Optional[str] = None)[source]
Bases:
BaseModel- causes: Optional[List[Any]]
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.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- display_message: Optional[str]
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: Optional[str]
The URL of a Plaid documentation page with more information about the error
- error_code: str
The particular error code. Safe for programmatic use.
- error_message: str
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
- error_type: str
A broad categorization of the error. Safe for programmatic use.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- classmethod parse_obj(data: Any) Error[source]
Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj
- classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) Error[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- request_id: Optional[str]
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
- status: Optional[float]
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: Optional[str]
Suggested steps for resolving the error