Open Finance Codes and Errors
Klavi APIs use standard HTTP error codes to communicate errors back to you. In particular, our APIs use standard HTTP status 416 to express business processing errors. Here's a table of the possible error codes that you may encounter while using our APIs:
Code | Description | Notes |
200, 201 | Successful Request | The request was successful. |
400, 422 | Bad Request | The request was malformed or missing required parameters. |
401 | Unauthorized | The access token provided was invalid or has expired. |
403 | Forbidden | The access token provided does not have sufficient permissions. |
404 | Not Found | The requested resource could not be found. |
409 | Conflict | The request conflicts with an existing resource. This error is usually related to idempotency key. |
416 | Business Processing Error | Some kind of business processing error occurred in the request. The filed "statusCode" in the response payload specifically represents a kind of business process error. Please refer to the response instructions for each API. |
429 | Too Many Requests | The API rate limit has been exceeded. Use exponential backoff for requests. The transactions per second (TPS) rate is adjusted based on the specific needs of each customer. |
500, 502, 503, 504 | Server Errors | Something went wrong on our end. If you receive this error, please contact our support team and provide the necessary information for us to investigate the issue. |
Code | Description | Notes |
4001 | Invalid authorisation info | Authorisation info has expired or does not exist |
4002 | Invalid product info | Product info does not exist or the product level is not correct |
4003 | Invalid Consent Request | Consents exceeds the limit |
4004 | Invalid Institution | Institution already out age or don't have permission |
4005 | Invalid products | Products must not have fewer than 1 items |
4006 | Invalid productsCallbackURL | Invalid productsCallbackURL |
4007 | Product request failed | Product request failed |
The code plan in the product report is as follows:
- 5000 to 5099 are common error codes
- 5100 to 5299 are planned as business error codes for each module
Code | Description | Notes |
200 | OK | |
204 | Bank side some APIs not available | |
205 | Income info is null | |
5000 | Unexpected error | |
5001 | Task timeout | |
5002 | Consent expires | |
5003 | Bank side not available | |
5100 | Account is null | |
