Recover Enterprise API
Recover API Error Reference

6min
Overview
This document contains error codes and messages returned by the Recover API. Butter uses standard HTTP error codes, and parameters are provided in error responses to provide further guidance on the reason for the error.
﻿
HTTP Status Codes
Butter uses the following standard HTTP status codes:
2XX OK — The request was successful.
4XX Bad Request — The request is missing a required parameter or the request payload is incorrectly formatted.
5XX Server Error — The request failed due to an issue on the Butter side (rare).
Example Responses
Example 200
JSON
// Request Succesful
{
  "message": "Request submitted for processing",
  "request_id": "2c941653-b229-4528-b576-70fcfd388543:49645839701979566120793328447151049151317978254208401410:000000000000"
}
// Request Succesful
{
  "message": "Request submitted for processing",
  "request_id": "2c941653-b229-4528-b576-70fcfd388543:49645839701979566120793328447151049151317978254208401410:000000000000"
}
﻿
Example 400
JSON
// Request Failed Validation 
{
  "message": "Invalid request body",
  "errors": [
    {}
  ]
}
// Request Failed Validation 
{
  "message": "Invalid request body",
  "errors": [
    {}
  ]
}
﻿
Example 403
JSON
// Invalid API Key 
{
  "message": "Forbidden",
  "errors": "Invalid API Key"
}
// Invalid API Key 
{
  "message": "Forbidden",
  "errors": "Invalid API Key"
}
﻿
Example 404
JSON
// Method/Path Not Found 
{
  "message": "Method/Path combination not found."
}
// Method/Path Not Found 
{
  "message": "Method/Path combination not found."
}
﻿
Example 415
JSON
// Unsupported Media Type 
{
  "message": "Unsupported Media Type",
  "errors": "Content-Type must be application/json"
}
// Unsupported Media Type 
{
  "message": "Unsupported Media Type",
  "errors": "Content-Type must be application/json"
}
﻿
Example 500
JSON
// Server Error
// Server Error
﻿
﻿
﻿
Updated 30 Aug 2024
Did this page help you?
Introduction
Integrating With Recover
Recover API Error Reference

HTTP Status Codes

Example Responses

﻿
