Return Codes
API Return Codes
Klavi payment 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. |
Business Status Codes
Code | Description | Notes |
|---|---|---|
4101 | QrCode Not Related Pix | The scanned qrCode is not related to Pix |
4102 | QrCode From PixCobrança | The scanned qrCode is from "Pix Cobrança" |
4103 | QrCode From PixTroco | The scanned qrCode is from "Pix Troco" |
4104 | QrCode From PixSaque | The scanned qrCode is from "Pix Saque" |
4105 | Payment has been created | payment-links has been created(Only for whitelabel) |
4106 | Payment Initiation is canceled | Payment Initiation is canceled(Only for whitelabel) |
4107 | Consent has been created | Consent has been created(Only for whitelabel) |
4109 | Payment-fidoOptions unknown error | Payment-fidoOptions unknown error |
4110 | Payment final state | Payment-fidoOptions unknown error |