Skip to main content

Errors

Voucherly 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 Voucherly's servers (these are rare).

Errors are returned as problem details (RFC 7807). Please referer to official guides.

typestringnullable

A URI reference that identifies the problem type.

titlestring

A short, human-readable summary of the problem type. It remains consistent across occurrences of the same error type.

statusint32

The HTTP status code generated by the origin server for this occurrence of the problem.

detailstringnullable

A human-readable explanation specific to this occurrence of the problem.

codestring

For some errors that could be handled programmatically, a short string indicating the error code reported.

parameterstringnullable

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.