Responses and error-handling
Every request processed through the SingleView APIs will have a response among the following:
HTTP Status | Description | Handling |
|---|---|---|
200 | Success |
|
4XX | Client side error | Spot the invalid parameters from the message and retry by entering valid details |
5XX | Internal/server error | Retry later |
These middleware error are designed to pinpoint issues in the API integration layer before they reach the main application logic.
{
"correlationId": "2163bbf3-c6e1-4c0b-aac3-3b1b06552388",
"bankCode": "",
"errorCode": "MW-401",
"errorMessage": "Authentication token has expired. Please re-authenticate.",
"timeStamp": "2025-02-28T07:35:25.981+03:00"
}Response parameters
JSON Tag | Description | Data Type |
|---|---|---|
correlationId | Unique correlation identity parameter for each response of invalid access token | String |
bankCode | Unique bank identification code | Alphanumeric |
errorCode | Code representing the error encountered | String |
errorMessage | Message explaining the details about the error encountered | String |
timeStamp | Date and time of the error | Date |
errorCode | errorMessage |
|---|---|
MW-400 | Error occurs when one or more inputs in the header are missing:
Error occurs when a mandatory field is missing the request body:
|
MW-401 | This error occurs when authentication token is expired or an active token doesn't match the CompanyId mentioned in the header:
Error occurs if payload and signature doesn't match:
|
MW-403 | Error occurs when a user tries to access a service that they does not have a subscription:
|
MW-404 | Resource Not Found |
MW-405 | Requested Method not allowed |
MW-406 | Not acceptable |
MW-415 | Unsupported Media Type |
MW-429 | Too many requests received |
MW-500 | Technical error |
MW-503 | Service Unavailable |
MW-504 | Gateway Timeout |
This error occurs when there is an issue with TLS handshake.
{
"error": "Client certificate and private key are required",
"message": "Ensure that the request includes the client certificate issued by Singleview along with the corresponding private key."
}This error occurs where there is an issue regarding connectivity to the SingleView APIs.
<html>
<head>
<title>504 Gateway Time-out</title>
</head>
<body>
<center>
<h1>504 Gateway Time-out</h1>
</center>
<hr>
<center>nginx</center>
</body>
</html>