Field | Data Type | Description |
---|---|---|
status | Integer | Standard HTTP status code indicating the result of the request. Examples: 200 for success , 400 for Bad Request , 401 for Unauthorized , 500 for Internal Server Error. |
serviceStatus | String | A system-specific status code that offers a more granular classification of the error within the service. This code helps developers quickly identify and troubleshoot the exact issue in the system’s error catalog. |
titleCode | String | A short, machine-readable error identifier used to categorize the type of problem. |
title | String | A brief, human-readable summary of the error type, meant to be easily understood without digging into technical logs. |
detail | String | A detailed message describing the specific cause of the error. This field helps developers or API consumers understand exactly what input caused the issue, so they can correct and resubmit the request. |
responseTime | String (ISO 8601) | The timestamp when the RemitPro system generated the response, in ISO 8601 format with timezone information. Useful for logging, auditing, and correlating logs. |
Status | Explanation | Expected handling |
---|---|---|
200 | API request was successful | Request processed successfully. |
400 | Invalid Request Parameters | - Validate client-side input before retrying. - Fix incorrect or missing request parameters. - Return or display a clear error message to the user. |
401 | Unauthorized access | - Check authentication token/credentials. -If the token is expired,refresh or re-authenticate. - Inform the user that authorization is required. |
403 | Forbidden access | - Do not retry automatically. - Verify user role/permissions. - Return an appropriate error message (“Access denied”). |
404 | Resource not found | - Ensure the endpoint or resource path is correct. - If the resource truly doesn’t exist, return a “Not Found” error. - Do not retry automatically. |
409 | Conflict | - Handle conflict (e.g., duplicate record, concurrent modification). - Notify the user that the operation failed due to a conflict. - Require client to resolve conflict before retrying. |
500 | Internal server error | - Error originates from the server, not the client. - Show a generic error message: “Something went wrong. Please try again later.” - Do not retry continuously; apply exponential backoff if retrying. Log and monitor the error for investigation. |