Errors

Our API 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 our servers (these are rare).

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

Error code

Attributes are returned as JSON objects, examplified as follows:

{
    "title": "string",
    "type" : "string",
    "traceId" : "string "
}

Attributes

title (string)

A human-readable message providing more details about the error.

traceId (string)

A traceable id which corrolates with our logging records.

type (string)

The type of error returned.