Refund Cover Integration Guide

Appendix

Appendix 2: Response and error codes

All correct responses will return a 200 OK with an empty body. 4xx error responses will return a JSON error block with the error code and an explanation of the issue.

We recommend that in production, these responses are logged for review to identify ineligible sales or invalid requests.

Code Message Explanation
200 OK Request actioned.
400 Bad request Unexpected data in request.
401 Unauthorised Check your vendor ID and API key is correct.
405 Method not allowed POST requests only.
408 Request timeout Try again later.
413 Request too large Request data too large.
422 Unprocessable content Incorrect or missing data, see details in response.
429 Too many requests You have hit a rate limit, back off sending requests and try again later.
500 Internal error General error, try again later and contact us if this persists.

Example error response

We return errors as our validator identifies them, so an error message may not necessarily include all errors and repeat attempts may be required to identify all errors.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "status_code": 422,
    "error_code": "validation_error",
    "message": "Unprocessable Content: Some of the data provided could not be validated.",
    "details": [
        {
            "field": "purchase_reference",
            "issue": "The value provided for 'purchase_reference' exceeds the maximum length allowed, which is 25 characters."
        },
        {
            "field": "product_type",
            "issue": "The value provided for is not one of [ticket, accommodation]."
        }
    ]
}