Error Messages

HTTP Status Error Codes

The service's API uses standard HTTP Status codes, including:

400 invalid request - it can also signify a business error. You can review the error's details for further information
401 unauthorized
500 internal server error - generally, the operation should be retried later and if the error persists, support should be contacted.

Error Information in API Responses

Whenever possible, the API will return an application/json response with error information, such as below:

{
    "errors": [
        {
            "type": "data-validation-failed",
            "message": "Could not assign seller data with code: GB-M2"
        }
    ]
}

This data structure contains error type (category) and message with additional details.

Error Types

The following table lists the error types that are present in API responses.

Error type	Retry	Comment
schema-validation-failed	No	This error means that the input request does not meet the formal criteria of the message, for example a field missing.
data-validation-failed	No	This error means that there is something wrong with the data values provided on a business level - for example unknown currency code.
resource-not-found	Depends	This error means that the request resource is not found. In some cases (for example back to back transactions generated in the background), it might be enough to just retry after a certain time.
general-persistence-failure	Yes	This error signifies that the data has not been persisted successfully. The API architecture is built specifically to prevent that by removing a single point of failure for transaction storage. Other operations, which are requiring a single centralized resource and are not a part of the on-line sales process (such as transaction confirmation), can signify that error and they should be retried after a short delay in such a case.
external-unique-id-already-exists\|refund-unique-reference-already-exists	No	This means that the unique ID of an object that the API call is attempting to store already exists - most likely it was stored upon a previous call and the error is being raised upon retry.
resource-usage-exceeded	Yes (after delay)	This error signifies that this account is using too much of a given resource. The solution here is to implement a back-off algorithm and retry after a short delay.
external-system-error	Yes	This error can signify an issue raised when communicating with an external system, that prevents rendering a proper response. In cases of VAT/GST number validation, the system might raise a warning and still calculate tax - depending on account settings.
tax-country-not-detected	No	This error signifies that there was not enough information (usually evidence) to determine a tax country for one or more lines. The response will contain some tax-related information anyway, including countries resolved from digital goods location evidence.
required-fields-missing	No (not without updating the field information)	This error means that more information is required to proceed with the request - usually address data. Consult the `required_fields` response field for details. These can be used to automatically manage requirement of the input fields if feasible.
input-validation-failed	No	This error means that the message could not have been parsed.
general-error	Yes	The operation should be retried later and if the error persists, support should be contacted.
api-authentication-failed	No	Check your authentication data.

Updated over 1 year ago