Sha256: bd1371c20c307f8b2a4fd5fc9418236141ef14062a9b0f8f3c7e797de77c9cc0

Contents?: true

Size: 1.17 KB

Versions: 5

Compression:

Stored size: 1.17 KB

Contents

# VeloPayments::Error

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **error_message** | **String** | English language message indicating the nature of the error | [optional] |
| **error_code** | **String** | Unique numeric code that can be used for switching client behavior or to drive translated or customised error messages | [optional] |
| **localisation_details** | [**LocalisationDetails**](LocalisationDetails.md) |  | [optional] |
| **location** | **String** | the property or object that caused the error | [optional] |
| **location_type** | **String** | the location type in the request that was the cause of the error  | [optional] |
| **reason_code** | **String** | a camel-cased string that can be used by clients to localise client error messages (deprecated) | [optional] |
| **error_data** | [**ErrorData**](ErrorData.md) |  | [optional] |

## Example

```ruby
require 'velopayments'

instance = VeloPayments::Error.new(
  error_message: size must be between 0 and 10,
  error_code: 20110003,
  localisation_details: null,
  location: firstName,
  location_type: requestBody,
  reason_code: validationError,
  error_data: null
)
```

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
velopayments-2.37.150.beta1 docs/Error.md
velopayments-2.35.58 docs/Error.md
velopayments-2.35.58.beta1 docs/Error.md
velopayments-2.29.128.beta1 docs/Error.md
velopayments-2.26.124.beta1 docs/Error.md