Response Codes and Error handling

Response Codes

Our API services typically use following HTTP response codes and their meaning. Any deviations or additional details are described separately with each service reference.

CODE	Standard Meaning	Description
200	OK	Typically response to a successful GET request.
202	Accepted	Typically response to a successful POST request.
204	No Content	Service responded successfully, but there is no content - typically empty GET /messages service response.
403	Forbidden	Authorization or authentication failure. Typical cases: certificate is not valid or expired, the service is not enabled for the customer or Client-Code and Client-Country headers are not valid for the Service Provider model
404	Not Found	Resource is not found. Typically a specific message is already deleted or does not exist.
429	Too many requests	Too many requests in a given amount of time.
500	Internal Server Error	Technical error. Typically unplanned service interruption.
503	Service Unavailable	Technical error. Can also be used during planned maintenance

Error Handling

In case of any errors our default structure of error details is following.

Service specific details of error codes and messages can be found at each service description.

INDEX	MULT.	ELEMENT	XML TAG	DESCRIPTION
1.0	[1..1]	Errors	<Errors>
1.1	[1..n]	+Error	<Error>
1.2	[1..1]	++ErrorCode	<ErrorCode>	For example, see list of Account Statement Request Error Codes.
1.3	[1..1]	++Description	<Description>	Description text.
1.4	[0..1]	++Field	<Field>	Reference to faulty field.

Sample

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Errors>
    <Error>
        <ErrorCode>errStatement_PeriodInvalid</ErrorCode>
        <Description>From date cannot be later than to date.</Description>
        <Field>FrDt</Field>
    </Error>
    <Error>
        <ErrorCode>NotNull</ErrorCode>
        <Description>Name can't be null</Description>
        <Field>Name</Field>
    </Error>
</Errors>

General error codes