Problem Details

Problem detail responses provide the standard error response body returned with supported HTTP error status codes. The following table lists fields that may appear in problem detail responses. Field availability varies by API and error condition.

General problem detail example:

{
    "type": "error:validation",
    "title": "Required value not specified.",
    "detail": "The orgShortName value is required.",
    "instance": "required_value_missing"
}

Checks API problem detail with posDetails:

{  
    "title": "General Service Error",
    "status": 400,
    "detail": "The POS system could not process the request.",
    "instance": "error:pos-processing-error",
    "posDetails": [
    {
      "code": "general_pos_error",
      "message": "Check opened on system"
      }
    ]
}

Checks API problem detail with menu item not available posDetails:

{  
    "title": "POS Error",
    "status": 400,
    "detail": "The POS system is unable to process the request.",
    "instance": "error:pos-error",
    "posDetails": [
    {
      "code": "menu_item_not_available",
      "message": "Cannot be ordered : Out of MenuItemId 2, SequenceNumber 1"
      }
    ]
}

Name	Description	Type	Always Present	Example
type	A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".	string	No	"error:validation"
title	A short, human-readable summary of the problem type.	string	No	"Required value not specified."
status	A HTTP response status code.	integer	No	400
detail	A human-readable explanation specific to this occurrence of the problem.	string	No	"The orgShortName value is required."
instance	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.	string	No	"required_value_missing"
posDetails	Problem details returned from the POS system while processing a Checks API request.	array[object]	No	[{...}]
posDetails.code	Short, unique identifier for the POS processing detail.	string	No	"general_pos_error"
posDetails.message	A human-readable explanation specific to this POS processing detail.	string	No	"Check opened on system"