Online API

Errors

The Clearpay API uses the conventional HTTP status codes to indicate success or failure of an API request.

HTTP Status CodesDescription
200-299The request was processed successfully.
400-499The request was not valid (e.g. a required parameter was missing).
500-599The request could not be processed for an unexpected reason.

Response

Returns a JSON object and an appropriate HTTP status code.

Please note that the human-readable textual messages included within the error object are improved over time. For validation and mapping purposes, please use the error code or HTTP status code values.

AttributeTypeDescription
errorCodestringThe type of error returned. For example, invalid_object, unsupported_currency, or invalid_token.
errorIdstringA unique error ID.
messagestringA human-readable message which provides more details about the error. In most cases, these messages can be displayed to the end user.
httpStatusCodeintegerThe HTTP status code.
Note

If you intend to contact Clearpay about an unexpected API response, please make sure you record the raw headers & body from your request, along with the raw headers & body received in response.