HTTP Errors

In cases where an API request is made and the error can be detected immediately, an applicable HTTP status code is returned. 

General Error Format

HTTP status codes do not always provide sufficient information about the cause of an error. Responses contain additional JSON fields describing the error for more detailed programmatic handling of errors.

HTTP/1.1 400 Bad RequestContent-Type: application/json

{
  "code": 2,
  "message": "API parameter invalid"
}

Extended Format

In some cases, extended information is available for clients about why a request has failed. For example, failing to supply a value for a required field will result in the following error:

HTTP/1.1 400 Bad RequestContent-Type: application/json

{
  "code": 2,
  "message": "API parameter invalid",
  "errors": [
    {
      "error": "required",
      "message": "fail to bind request to CreateWalletSetRequest: EOF",
      "location": "field1",
      "invalidValue": "null",
      "constraints": { }
    }
  ]
}

Circle’s Extended Error Messages

Below are some common extended error messages you may encounter as you implement Circle’s Programmable Wallets API.