Kyshi 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 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Kyshi's servers.

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

HTTP Status Code Summary

200 - OKEverything worked as expected.
201 - CreatedEverything worked as expected and a new record has been created
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
422 - Unprocessable EntityThis means we understands the content type of the request body, and the syntax of the request body is correct however we're unable to process the contained instructions.
429 - Too Many RequestsToo many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 - Server ErrorsSomething went wrong on Kyshi's end.

Error Responses

  "status": false,
  "message": "Unsupported Merchant Currency",
  "code": 422,
  "data": {}