# List of errors

This page lists all error codes and their related messages that may be received from the API. They are organized by the returned HTTP error code and by feature.

Warning

This list of error codes is subject to change. Please ensure your error management system is flexible enough to handle new HTTP response codes and API error codes.

# 207 - Partial Success

This is a special type of error response in which the response body includes the successful response along with an error response object.

Code	Documentation	Comments
207-762	Voucher issuance was only partially successful.	For more information, see the Partially successful issuance section.

# 400 Bad Request - Error in the request headers, path parameters or body

The errors listed in this section receive the HTTP 400 response code and are caused by requests with missing or invalid parameters (a header, path parameter or request body field).

The field error documentation should be self-explanatory. If you have any questions, please contact UNIQREWARDS API Support.

# Issue voucher 400 errors

Code	Documentation
400-056	The requested product is an open-value type and requires a valid face_value parameter in the request body. The face_value must be specified in cents and must be between 100 and 100000.
400-0C6	The requested quantity is greater than the available stock.
400-4C3	Unable to parse the request body. Please refer to the OpenAPI specification to verify the required parameters and field formats.
400-5DC	Voucher issuance requests require a valid quantity parameter in the request body, with a value between 1 and 20.
400-9A0	The Idempotency-Key header is required for this route.
400-BB4	The Idempotency-Key header must be in UUID format.

# Retrieve vouchers 400 errors

Code	Documentation
400-215	The array query parameter id must contain unique values.
400-67B	The query parameter id must be a list of UUIDs separated by commas.
400-B32	The query parameter id can support up to 20 values.
400-E12	The path parameter voucher id must be in UUID format.

# 401 Unauthorized - Authorization errors

The 401 errors are common to all features of the API and relate to authentication or authorization issues.

Code	Documentation	Comments
401-20D	Invalid authorization token.	A common cause of the invalid token error is token expiration. See the auth token documentation for more details
401-740	Route not authorized by the scope claim of the auth token.	This issue is commonly caused by environment or authorization mismatches. More information is available in the scope documentation section.
401-92E	Missing auth token in headers.	Refer to the use the auth token documentation for more details.

# 404 Not Found - The requested resource is not found

# 404 errors common to all routes

Code	Documentation	Comments
404-4BD	The path and / or the method is not supported.	This is the generic 404 error for a route that does not exist in the API.

# Retrieve product or issue vouchers 404 errors

Code	Documentation	Comments
404-130	Product not found. Please verify the product code parameter in the path.	Use retrieve catalogue of vouchers to ensure the requested product code is available in the catalogue.

# Retrieve vouchers 404 errors

Code	Documentation	Comments
404-D4E	Voucher not found in records. Please verify the voucher id parameter in the path.	At least one of the requested vouchers is not in the API records and cannot be returned.

# 409 Conflict

Code	Documentation	Comments
409-7F2	An idempotency record was found for the key {idempotency_key}, but the request path {request_path} does not match the idempotency record.	The idempotent retry must be attempted with the same initial request path.

# 500 Internal Server Error

500 errors are server errors and will return standard error messages for different error codes. Resolving these errors requires contacting UNIQREWARDS API Support. Please also refer to the getting help section.

Note

To assist us in the investigation, please provide the following context with your support request:

The environment where the error occurred
The date and time of the error
The request information, including path and parameters
The error response, including the request ID and the error code

# 500 Configuration Issues

A subset of 500 errors returns the message "Configuration Issue."

Errors in this category are caused by server-side configuration issues. Please contact us with the necessary details so we can address them.

Code	Documentation
500-049	API client configuration issue. Please contact support.api@uniqrewards.com and provide as much information as possible, including the request ID and error code.
500-14A
500-165
500-18D
500-4B0
500-4B9
500-7B9
500-83C
500-A3A
500-A78
500-C1A
500-F00
500-F87

# Other 500 errors

The following list of error codes will return a generic error message. Please contact us with the necessary details so we can address them.

Code	Documentation
500-2B0	Internal server error. Please contact support.api@uniqrewards.com and provide as much information as possible, including the request ID and error code.
500-38A
500-4F5
500-6D1
500-786
500-7F8
500-D7B
500-DA8

# 501 Not Implemented

The following list of error codes will return a 501 error and refer to features that are not yet implemented. This may be caused by configuration or other issues. Please contact us with the necessary details so we can address them.

Code	Documentation	Comments
501-4B1	Product not supported. Please contact support.api@uniqrewards.com and provide as much information as possible, including the request ID and error code.	Likely a server-side configuration issue.
501-79F	At least one of the vouchers is not supported. Please contact support.api@uniqrewards.com and provide as much information as possible, including the request ID and error code.	Investigation is required to identify the cause of this issue.
501-A22	Voucher not supported. Please contact support.api@uniqrewards.com and provide as much information as possible including the request ID and error code.	Investigation is required to identify the cause of this issue.
501-C7B	Route not yet implemented. Please refer to the OpenAPI specification.	The requested feature is not available but may be implemented in the future.

# 503 Service Unavailable

The Client API depends on other systems. If these systems are unavailable, the API may respond with a 503 Service Unavailable error.

Code	Documentation
503-FD4	Due to a dependency server issue, the service is not available. Please contact support.api@uniqrewards.com and provide as much information as possible, including the request ID and error code.

← Error responses