Status codes
Stenn 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 Stenn’s servers (these are rare). Error responses contain more detail about the error in the response body, in the "message"
property.
Code | Description |
---|---|
200 - OK | Everything worked as expected. |
400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 - Unauthorized | Missing or invalid API credentials. |
402 - Request Failed | The parameters were valid but the request failed. |
403 - Forbidden | The API key doesn't have permissions to perform the request. |
404 - Not Found | The requested resource doesn't exist. |
409 - Conflict | The request conflicts with another request (perhaps due to using the same idempotent key). |
429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
500, 502, 503, 504 - Server Errors | Something went wrong on Stenn’s end. (These are rare) |
Error response attributes
Attribute | Type | Description |
---|---|---|
message | String | A human-readable message providing more details about the error. For invoice errors, these messages can be shown to your users. |
exception_key | String | Unique identifier used internally by our support team to reference this error/exception |
Updated 9 months ago
What’s Next