List of API error codes

The root cause of errors can be generalised from the HTTP Response Code. The list below details the errors that could occur during an integration or in production.

HTTP Status Code	Name	General Guidelines
400	Bad Request	Check the payload or params
401	Unauthorized	Check the auth credentials
403	Forbidden	The credentials provided do not have access to the resources requested
404	Not Found	The requested resource does not exist
405	Method Not Allowed	Check the HTTP Request Type and check the `Content-Type` Header
429	Too Many Requests	Check that there are not too many requests being sent to the server
500	Internal Server Error	Needs to be raised to the Pay1st Implementation Manager

Error Format

All error messages typically consist of an errorMessage field and an errorCode field.

Response Field	Description
errorMessage	A message detailing the error that occurred
errorCode	A code to identify the error source
sessionId	A session identifier for the request. This will need to be sent to the Pay1st Implementation Manager so that it makes it easier to troubleshoot problems for any API requests

All error responses return a 4xx error HTTP status.

{
    "errorMessage": "ERROR_MESSAGE",
    "errorCode": "ERROR_CODE",
    "sessionId": "SESSION_ID"
}