Errors

Our API Endpoints use conventional HTTP response codes to indicate the success or failure of an API request.

General error codes

In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with our backend (these are rare).

Http Status Code	Message	Possible Payload
200	Ok	Request was successful and contains the response content
202	Accepted	The request has been accepted for processing, but the processing has not been completed
203	Non-Authoritative Information	Request was successful but contains business errors
400	Bad Request	The Request was incorrect (due to http protocol)
401	Unauthorized	Not authorized access to a endpoint
403	Forbidden	Not authorized access to a specific resource
404	Not Found	Resource not found
409	Conflict	Resource already exists
500	Internal Server Error	Unexpected Server Error
501	Not implemented	Method not implemented

Specific error codes

Not all errors map cleanly onto HTTP response codes, however. When a request is valid but does not complete successfully, we return a specific Error code.

Group	Type	Subtype	Code range
global	N/A	N/A	0 - 999
global	general errors	N/A	0 - 499
global	header parameter	N/A	500 - 999
global	not defined	not defined	1000 - 1999
query	N/A	N/A	200-3999

Group: query, Type: query parameters, Subtype: filtering

Group	Range
global	2000 - 2099
customer	2100 - 2199
addresses	2200 - 2299
personas	2300 - 2399
payment-instruments	2400 - 2499
orders	2500 - 2599
not defined	2600 - 2999

Group: query, Type: query parameters, Subtype: ordering

Group	Range
global	3000 - 3099
customer	3100 - 3199
addresses	3200 - 3299
personas	3300 - 3399
payment-instruments	3400 - 3499
orders	3500 - 3599
not defined	3600 - 3999

customers

Group	Type	Subtype	Code range
customers	general	N/A	4000 - 4099
customers	uri parameter	N/A	4100 - 4199
customers	body parameters	N/A	4200 - 4999
customers	not defined	N/A	5000 - 5999

addresses

Group	Type	Subtype	Code range
addresses	general	N/A	6000 - 6099
addresses	uri parameter	N/A	6100 - 6199
addresses	body parameters	N/A	6200 - 6999
addresses	not defined	N/A	7000 - 7999

personas

Group	Type	Subtype	Code range
personas	general	N/A	8000 - 8099
personas	uri parameter	N/A	8100 - 8199
personas	body parameters	N/A	8200 - 8999
personas	not defined	N/A	9000 - 9999

payment-instruments

Group	Type	Subtype	Code range
payment-instruments	general	N/A	10000 - 10099
payment-instruments	uri parameter	N/A	10100 - 10199
payment-instruments	body parameters	N/A	10200 - 10999
payment-instruments	not defined	N/A	11000 - 11999

orders

Group	Type	Subtype	Range
orders	general	N/A	12000 - 12099
orders	uri parameter	N/A	12100 - 12199
orders	body parameters	N/A	12200 - 12999
orders	not defined	N/A	13000 - 13999

transactions

Group	Type	Subtype	Code range
transactions	general	N/A	14000 - 14099
transactions	uri parameter	N/A	14100 - 14199
transactions	body parameters	N/A	14200 - 14999
transactions	not defined	N/A	15000 - 15999

payment

Group	Type	Subtype	Code Range
payment	body parameters	N/A	16000 - 16999

connectors

Group	Type	Subtype	Code Range
general	general	N/A	25000 - 25999
creditcard	provider response	N/A	26000 - 26999
paypal	provider response	N/A	27000 - 27999
paydirekt	provider response	N/A	28000 - 28999
ratepay	provider response	N/A	29000 - 29999
sepa	provider response	N/A	30000 - 31999