UseePay uses conventional HTTP response codes to indicate the success or failure of an API request. Typically a status code in the 2xx range indicates success, status codes in the 4xx range indicate an error that has been triggered due to the information provided (for example; a parameter does not meet the validation requirements or was not provided), and status codes in the 5xx range indicate an error with UseePay servers.When we send an error response, the body will generally contain the following fields:Response body attributes#
| JSON Field | Description |
|---|
| code | Error codes (please refer to reference table) |
| source | Name of the request parameter that caused the error |
| message | Description of the error |
HTTP status codes#
| Code | Description |
|---|
| 200 | OK - The request was processed successfully |
| 201 | Created - The request was processed successfully |
| 400 | Bad request - The request contains missing parameters, is in an incorrect shape, or failed another validation test |
| 401 | Unauthorized - Please verify that the authentication token is provided and is valid |
| 404 | Not found - The requested endpoint does not exist |
| 500 | Server error - Something went wrong on our end; please let us know if you are receiving this error |
Error codes#
| Code | Message |
|---|
| already_exists | The entity requested to be created already exists |
| field_required | A mandatory field in the request is missing |
| invalid_argument | A provided argument has an incorrect type or failed a validation test |
| service_unavailable | The requested service is currently unavailable due to operating hours limitations, or because a third-party service is temporarily unavailable |
Modified at 2024-10-29 10:10:06
