Error Responses

Bridge returns structured error responses. Use the type field as the primary classifier for handling failures.

Some endpoints also include an optional message field with endpoint-specific detail.

Error shape

Error response example
1{
2 "type": "conflict_error",
3 "message": "Invalid Estimate Charge Status"
4}
FieldRequiredDescription
typeYesError category. See error types below.
messageNoEndpoint-specific detail. Documented in the API Reference where supported.

Message

When present, message is a string that narrows the failure within the type. Not every endpoint returns message, and the set of possible values is defined per endpoint.

Check the endpoint documentation in the API Reference for supported message values. For example, billing endpoints may document public message values for conflict_error responses.

error types

error_typeBrief description
invalid_request_errorRequest shape or parameters are invalid.
authentication_errorAuthentication is missing, invalid, or expired.
permission_errorAuthenticated caller does not have access to the resource.
resource_errorRequested resource was not found.
conflict_errorRequest conflicts with existing resource state.
validation_errorRequest data failed validation rules.
rate_limit_errorToo many requests were sent in a short period.
api_errorGeneric server-side failure.