{"_id":"59df6a573b756800107b208a","category":{"_id":"59df6a523b756800107b202b","version":"59df6a523b756800107b201e","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59df6a523b756800107b201e","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T13:12:50.128Z","releaseDate":"2017-10-12T13:12:50.128Z","categories":["59df6a523b756800107b201f","59df6a523b756800107b2020","59df6a523b756800107b2021","59df6a523b756800107b2022","59df6a523b756800107b2023","59df6a523b756800107b2024","59df6a523b756800107b2025","59df6a523b756800107b2026","59df6a523b756800107b2027","59df6a523b756800107b2028","59df6a523b756800107b2029","59df6a523b756800107b202a","59df6a523b756800107b202b","59df6a523b756800107b202c","59df6a523b756800107b202d","59df6a523b756800107b202e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-29T20:20:05.617Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"###Request\nN/A\n\n###Response\nThe `messages` resource is returned when an error occurs. See [Error handling overview](doc:error-handling-overview).\n\nThis resource is a container with this property:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`message`\",\n    \"0-2\": \"Container of <a href=\\\"#message\\\">message</a> properties.\\nThis property may appear more than once within the given resource.\",\n    \"0-1\": \"container\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n<a name=\"message\"></a>**message sub-resource**\nThe `message` resource is nested in the `messages` resource container (as shown above). It is a container with the elements described below, which provides details about the error and its cause.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Values\",\n    \"0-0\": \"`error-name`\",\n    \"3-0\": \"`invalid-property`\",\n    \"4-0\": \"`fraud-events`\",\n    \"0-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"0-2\": \"Name of the error that occurred.\",\n    \"3-2\": \"Property that caused the error.\",\n    \"3-3\": \"\",\n    \"4-2\": \"Container of [fraud-events / fraud-event](doc:fraud-event) properties.\",\n    \"1-0\": \"`code`\",\n    \"2-0\": \"`description`\",\n    \"1-1\": \"*integer*\",\n    \"2-1\": \"*string*\",\n    \"1-2\": \"BlueSnap error code.\",\n    \"2-2\": \"Description of the error that occurred.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Contains information regarding errors","slug":"messages","type":"basic","title":"messages / message"}

messages / message

Contains information regarding errors

Request

N/A

Response

The messages resource is returned when an error occurs. See Error handling overview.

This resource is a container with this property:

Property Name
Type
Description

message

container

Container of message properties.
This property may appear more than once within the given resource.

message sub-resource
The message resource is nested in the messages resource container (as shown above). It is a container with the elements described below, which provides details about the error and its cause.

Property Name
Type
Description

error-name

string

Name of the error that occurred.

code

integer

BlueSnap error code.

description

string

Description of the error that occurred.

invalid-property

string

Property that caused the error.

fraud-events

string

Container of fraud-events / fraud-event properties.