Adyen · Schema

RestServiceError

PaymentsFinancial ServicesFintech

Properties

Name Type Description
detail string A human-readable explanation specific to this occurrence of the problem.
errorCode string A code that identifies the problem type.
instance string A unique URI that identifies the specific occurrence of the problem.
invalidFields array Detailed explanation of each validation error, when applicable.
requestId string A unique reference for the request, essentially the same as `pspReference`.
response object JSON response payload.
status integer The HTTP status code.
title string A short, human-readable summary of the problem type.
type string A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
View JSON Schema on GitHub

JSON Schema

adyen-restserviceerror-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RestServiceError",
  "title": "RestServiceError",
  "properties": {
    "detail": {
      "description": "A human-readable explanation specific to this occurrence of the problem.",
      "type": "string"
    },
    "errorCode": {
      "description": "A code that identifies the problem type.",
      "type": "string"
    },
    "instance": {
      "description": "A unique URI that identifies the specific occurrence of the problem.",
      "type": "string"
    },
    "invalidFields": {
      "description": "Detailed explanation of each validation error, when applicable.",
      "items": {
        "$ref": "#/components/schemas/InvalidField"
      },
      "type": "array"
    },
    "requestId": {
      "description": "A unique reference for the request, essentially the same as `pspReference`.",
      "type": "string"
    },
    "response": {
      "description": "JSON response payload.",
      "$ref": "#/components/schemas/JSONObject"
    },
    "status": {
      "description": "The HTTP status code.",
      "format": "int32",
      "type": "integer"
    },
    "title": {
      "description": "A short, human-readable summary of the problem type.",
      "type": "string"
    },
    "type": {
      "description": "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "errorCode",
    "title",
    "detail",
    "status"
  ],
  "type": "object"
}