Status Codes
This guide covers the different status codes you can encounter when interacting with the Credit API. For status codes used in the Accounts, Cards & Payments API check the other Status Codes guide.
Response error messages include an HTTP status code and an error message. For example, if you try to make a request without sending all the required parameters, the response will be something similar to:
{
"code": 400,
"message": "invalid parameters",
"details": "email is missing"
}
The following table explains the different HTTP status codes used in the Credit API. The API follows the HTTP Status Codes published by the Internet Engineering Task Force (IETF)
HTTP Status Code | Description |
---|---|
200 | OK. The request has succeeded. The response will contain an entity describing or containing the result of the action. |
201 | Created. The request has been fulfilled and resulted in a new resource being created. |
400 | Bad Request. The server cannot or will not process the request due to something that is perceived to be a client error. For example, you might have missed a required parameter in the request body. |
401 | Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource. Verify the credentials you are using. |
403 | Forbidden. The resource you are trying to access is not available for you. Verify the credentials and identifiers you are using. |
404 | Not found. The information you are looking for you couldn’t be found. Verify that the request id and URL are spelled correctly. |
409 | Conflict. Indicates a conflict with an existing entity. For example, you attempted to create the same client more than once. |
413 | Payload Too Large. The server is refusing to process a request because the request payload is larger than the server is willing or able to process. |
500 | Internal Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request. |
503 | Service Unavailable. The server is currently unable to handle the request due to a temporary overload or scheduled maintenance. |