Errors Handling & Exceptions

GAINSConnect API endpoints implement standard HTTP response codes for various error scenarios.

HTTP Response Code	Description
400 Bad Request	Requests where the query parameters are missing or invalid
401 Unauthorized	All endpoints where the user is not authenticated
403 Forbidden	All endpoints where the user is authenticated but not authorized for that specific endpoints
404 Not Found	Attempting to access a route that does not exist
429 Too Many Requests	Indicates rate limiting thresholds have been surpassed for a particular endpoint

For certain types of errors, we will include a JSON payload such as:

HTTP 400 Bad Request
{
  "reason": "The webhook test attempt failed due {reason}"
}