KohortPay uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • Codes in the 2xx range indicate success.
  • Codes in the 5xx range indicate an error with KohortPay’s servers (these are rare).
  • Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).

Attributes

NameTypeDescription
typestringThe type of error returned. One of api_error or invalid_request_error.
messagestringA human-readable message providing more details about the error.
codestringThe code of the error.

Example

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid Authorization header. Expected: [Basic|Bearer] <credentials>",
    "code": "Unauthorized"
  }
}