API-Errors

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

Name

Description

Type

Possible values

status

Request status

string

"error"

error

Exception name

string

See "Exception Names"

error_details

Error details

string

Text

error_user

Error details in German

string

Text

code

The ID of the error type

int

See API error list

supportId

Id by which support team can relate error with action(s) that causes it

string

Alphanumerical string

Exception names

Name

Meaning

ProductException

generic error

ProductUnauthorizedException

authorization failed

ProductNotAllowedException

missing access rights

ProductNotEnoughBalanceException

card balance is utilised

ProductBlacklistedException

card or product is on a blacklist

ProductInternalException

internal error

ProductFormatException

validation error

ProductUnknownActionException

unknown url/endpoint

ProductNotFoundException

unknown id

ProductMethodNotAllowedException

http method used is not supported on url/endpoint

ProductUpdateFailedException

update was not possible

ProductDuplicateException

data already exists

ProductSecurityException

invalid credentials or request limit exceeded

ProductBackendproviderException

external service error

ProductPasscodeIncorrectException

loyalty merchant card pin was invalid

Error-Codes

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