Each HTTP request will return a response with a HTTP status Code. This status code must be examined to determine the status of the request. Errors will include error details in the response body in either XML or JSON format (depending on the request content type).
Success (2xx) |
|
200 OK |
Request successful |
201 Created |
Request successful and a new record created |
204 No Content |
Request successful with no response body |
Client Error (4xx) |
|
400 Bad Request |
Request cannot be fulfilled due to bad syntax |
401 Unauthorized |
API key is missing or invalid |
402 Payment Required |
Your account has been marked as unpaid. Please pay any outstanding invoices |
403 Forbidden |
Insufficient privileges to perform that action. Verify your login credentials are for the appropriate account |
404 Not Found |
The requested resource could not be found for the given identifier |
405 Method Not Allowed |
A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource |
406 Not Acceptable |
The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Valid Accept headers are application/xml and application/json |
412 Precondition Failed |
The server does not meet one of the preconditions that the requester put on the request. Example: trying to process a payment for a stored payment method that does not exist |
422 Unprocessable Entity |
The request was well-formed but was unable to be followed due to semantic errors. See body for details |
429 Too Many Requests |
You have made too many API requests in the last hour. Future API requests will be ignored until the beginning of the next hour. |
Server Error (5xx) |
|
500 Internal Server Error |
A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
502 Bad Gateway |
The web server has trouble connecting. Please try the request again. |
503 Service Unavailable |
The service is temporarily unavailable. Please try the request again. |