API Reference

These are a full list of error codes returned by the Pay1st APIs

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.

  • 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 request type and check the Content-Type.
  • 500 - Internal Server Error. Raise this issue with the Pay1st support team.

Error Format

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

Response FieldDescription
errorMessageA message detailing the error that occurred
errorCodeA code to identify the error source

All error responses return a 4xx error HTTP status.

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