Skip to main content

Error

Error represents a blocking issue returned with the response.

typetype (string)

Error type grouping to help the client react appropriately.

Possible values: [ERR_TYPE_NONE, ERR_TYPE_UNKNOWN, ERR_TYPE_CLIENT, ERR_TYPE_PROVIDER, ERR_TYPE_SERVICE]

codecode (string)

Specific error code exposed by the aggregator.

Possible values: [ERR_CODE_NONE, ERR_CODE_UNKNOWN, ERR_CODE_ACCESS_DATA_MISSING, ERR_CODE_BAD_RESPONSE, ERR_CODE_BAD_REQUEST, ERR_CODE_MISSING_FIELDS, ERR_CODE_CONFIGURATION]

descriptiondescription (string)

Human readable description of the error.

additionalData object

Additional key/value data associated with the error.

property name*value (string)
accessIdaccessId (string)

Access identifier that produced the error when applicable.

Error
{
  "type": "ERR_TYPE_NONE",
  "code": "ERR_CODE_NONE",
  "description": "string",
  "additionalData": {},
  "accessId": "string"
}