Contents

# Plaid::Error

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **error_type** | **String** | A broad categorization of the error. Safe for programatic use. |  |
| **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. |  |
| **display_message** | **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. | [optional] |
| **request_id** | **String** | A unique identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks. |  |
| **causes** | [**Array<AnyType>**](AnyType.md) | 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`. | [optional] |
| **status** | **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. | [optional] |
| **documentation_url** | **String** | The URL of a Plaid documentation page with more information about the error | [optional] |
| **suggested_action** | **String** | Suggested steps for resolving the error | [optional] |

## Example

```ruby
require 'plaid'

instance = Plaid::Error.new(
  error_type: null,
  error_code: null,
  error_message: null,
  display_message: null,
  request_id: null,
  causes: null,
  status: null,
  documentation_url: null,
  suggested_action: null
)
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
plaid-14.0.0.beta.4	docs/Error.md
plaid-14.0.0.beta.3	docs/Error.md
plaid-14.0.0.beta.2	docs/Error.md
plaid-14.0.0.beta.1	docs/Error.md