Error handling and error codes

{
    "error": 1,
    "error_id": 1001,
    "error_code": "INVALID_API_KEY",
    "error_message": "Invalid API key."
}

List of common errors codes and messages for all POST parameters

Below are common error codes for POST parameters. These will validate if any required POST parameter is missing, if it is null, length and size of the parameters etc. Same error code can be used for more than one POST parameter.

In the above table %field_name% can be any expected parameter that must be sent in the POST data. For example, let us take below POST data.

{
    "api_key": "1pghjl4v5apt2bks",
    "username": "test_user",
    "password": "test1234",
    "transaction_id": 1234
}

{
    "error": 1,
    "error_detail": {
            "id": 2001,
            "code": "INVALID_TRANSACTION_ID",
            "message": "Transactionid is required."
       }
}

error ‘code’ would be ‘INVALID_’ followed by missing parameter name in capitals i.e. ‘INVALID_TRANSACTION_ID’ and ‘message’ would be ‘parameter name without underscore, words separated by space’ and followed by ‘is required.’ i.e. ‘Transaction id is required’.

Same is the case with all the POST parameters that fall into the above validation criteria from id 2001 to 2011.

List of Error codes and messages (Excluding common code and message)