HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
These docs are for v2017-01-01. Click to read the latest docs for v2021-03-10.

Responses

Xola uses conventional HTTP response codes to indicate the success or failure of an API request. 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 conflict occurred etc.), and codes in the 5xx range indicate an error with Xola's servers (these are rare).

Not all errors map cleanly onto HTTP response codes, however. When a request is valid but does not complete successfully (e.g., a card is declined), we return a 402 error code.

CodeMeaning
2xx - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
402 - Payment requiredThe parameters were valid but the request failed. Usually due to invalid credit card details.
403 - ForbiddenYou do not have the access to this resource
404 - Not FoundThe requested resource doesn't exist.
409 - Conflict
5xx - Server ErrorsSomething went wrong on Xola's end. (These are rare.)