Introduction

All API errors use the same structure to pass information about it. Some (but not all) have unique HTTP status code associated, so best way to distinguish is to check payload.

Example

{
    "status": "error",
    "error": "ProductUnauthorizedException",
    "error_details": "Invalid token",
    "error_user": "ung├╝ltiger Token",
    "code": 0,
    "supportId": "af545b27c2d1f0bfd51254a96ffe32c6"
}

Definition

ProductExceptionPayload

NameDescriptionTypePossible values
status

Request status

string"error"
errorException namestringSee "Exception Names"
error_detailsError detailsstringText
error_userError details in GermanstringText
code

The ID of the error type

intSee API error list
supportIdId by which support team can relate error with action(s) that causes itstringAlphanumerical string

Exception names

NameMeaning
ProductExceptiongeneric error
ProductUnauthorizedExceptionauthorization failed
ProductNotAllowedExceptionmissing access rights
ProductNotEnoughBalanceExceptioncard balance is utilised
ProductBlacklistedExceptioncard or product is on a blacklist
ProductInternalExceptioninternal error
ProductFormatExceptionvalidation error
ProductUnknownActionExceptionunknown url/endpoint
ProductNotFoundExceptionunknown id
ProductMethodNotAllowedExceptionhttp method used is not supported on url/endpoint
ProductUpdateFailedExceptionupdate was not possible
ProductDuplicateExceptiondata already exists
ProductSecurityExceptioninvalid credentials or request limit exceeded
ProductBackendproviderExceptionexternal service error
ProductPasscodeIncorrectExceptionloyalty merchant card pin was invalid

Error-Codes

Please go to the site Errors to see the list of defined error codes.