{"title":"Errors","category":"default","creationDate":1776961629,"content":"<p>When an API request results to an error, Adyen sends a response with the error details in the body and a corresponding HTTP status code. The response body contains a description of the error, possible causes, and a link to a documentation page.<\/p>\n<h2>HTTP status codes<\/h2>\n<p>Adyen sends the following HTTP status codes in the header:<\/p>\n<ul>\n<li><a href=\"https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Status#successful_responses\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">\n  <strong>2xx<\/strong>\n<\/a>- The request is successful.<\/li>\n<li><a href=\"https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Status#client_error_responses\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">\n  <strong>4xx<\/strong>\n<\/a>- The request failed because of the information in the request, such as values with incorrect format, or not having the required fields.<\/li>\n<li><a href=\"https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Status#server_error_responses\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">\n  <strong>5xx<\/strong>\n<\/a>- The request failed because of errors with Adyen's servers.<\/li>\n<\/ul>\n<h2>Error response fields<\/h2>\n<p>The error responses use the <a href=\"https:\/\/tools.ietf.org\/html\/rfc7807\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">RFC 7807<\/a> format.<\/p>\n<div class=\"sticky-table-container\">\n    \n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>type<\/code><\/td>\n<td style=\"text-align: left;\">A URL of a documentation page where you can find more information about the error.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>title<\/code><\/td>\n<td style=\"text-align: left;\">A generic description of the problem.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>status<\/code><\/td>\n<td style=\"text-align: left;\">The HTTP status code.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>detail<\/code><\/td>\n<td style=\"text-align: left;\">An explanation of the error.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>requestId<\/code><\/td>\n<td style=\"text-align: left;\">An Adyen-generated unique identifier for the request. If you need help from our Support team, this is the ID that you need to provide them so they can investigate.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>errorCode<\/code><\/td>\n<td style=\"text-align: left;\">Unique error code. Use the error code to build your error handling logic.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>invalidFields<\/code><\/td>\n<td style=\"text-align: left;\">A list of required fields that are missing from the request, or have invalid data. Each entry contains: <br>-<code>name<\/code>: The name of the field on the request.<br> -<code>message<\/code>: Provides an explanation of the error, and solutions on what you can do to fix the error. <br> -<code>value<\/code>: Returned when a field has invalid data. This contains the value from the request.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n<h2>Example<\/h2>\n<p>Here's an example of an error response for a request that contains a date with an incorrect format.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Invalid date format'\" :id=\"''\" :code-data='[{\"language\":\"bash\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"type\\\": \\\"https:\\\/\\\/docs.adyen.com\\\/errors\\\/validation\\\",\\n    \\\"title\\\": \\\"The request is missing required fields or contains invalid data.\\\",\\n    \\\"status\\\": 422,\\n    \\\"detail\\\": \\\"Invalid legal entity information provided\\\",\\n    \\\"requestId\\\": \\\"1W3ZNX5TDKH29T0M\\\",\\n    \\\"invalidFields\\\": [\\n        {\\n            \\\"name\\\": \\\"individual.birthData.dateOfBirth\\\",\\n            \\\"value\\\": \\\"12-30-1966\\\",\\n            \\\"message\\\": \\\"Invalid date value provided. Expected format yyyy-MM-dd\\\"\\n        }\\n    ],\\n    \\\"errorCode\\\": \\\"30_102\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/errors","articleFields":{"description":"Learn about error codes from Adyen APIs and how to resolve them.","robots":"index,follow","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/errors","title":"Errors","content":"When an API request results to an error, Adyen sends a response with the error details in the body and a corresponding HTTP status code. The response body contains a description of the error, possible causes, and a link to a documentation page.\nHTTP status codes\nAdyen sends the following HTTP status codes in the header:\n\n\n  2xx\n- The request is successful.\n\n  4xx\n- The request failed because of the information in the request, such as values with incorrect format, or not having the required fields.\n\n  5xx\n- The request failed because of errors with Adyen's servers.\n\nError response fields\nThe error responses use the RFC 7807 format.\n\n    \n\n\n\nField\nDescription\n\n\n\n\ntype\nA URL of a documentation page where you can find more information about the error.\n\n\ntitle\nA generic description of the problem.\n\n\nstatus\nThe HTTP status code.\n\n\ndetail\nAn explanation of the error.\n\n\nrequestId\nAn Adyen-generated unique identifier for the request. If you need help from our Support team, this is the ID that you need to provide them so they can investigate.\n\n\nerrorCode\nUnique error code. Use the error code to build your error handling logic.\n\n\ninvalidFields\nA list of required fields that are missing from the request, or have invalid data. Each entry contains: -name: The name of the field on the request. -message: Provides an explanation of the error, and solutions on what you can do to fix the error.  -value: Returned when a field has invalid data. This contains the value from the request.\n\n\n\n\n\n\nExample\nHere's an example of an error response for a request that contains a date with an incorrect format.\n\n    \n","type":"page","locale":"pt","boost":19,"hierarchy":{"lvl0":"Home","lvl1":"Errors"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"\/pt\/errors"},"levels":2,"category":"","category_color":"","tags":["Errors"]}}
