Skip to content

Response Codes

Common Codes

CodeMeaning
200Request succeeded.
201Resource or claim created.
400Invalid request payload, parameter, or required header.
401Missing or invalid authentication/signature headers.
403Access forbidden by policy, scope, or allowlist rules.
404Requested resource not found.
409Idempotency conflict, in-progress duplicate, or conflict state.
422Business-rule rejection (for example limit validation, or account not enabled for the product line).
429Too many attempts; retry after cooldown.
500Unexpected server error.

Endpoint-Specific Codes

Some integration endpoints may also return:

CodeMeaning
502Upstream provider failure.
503Service temporarily unavailable.
504Upstream provider timeout.

Error Envelope

json
{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}

Notes

  • Handle responses by statusCode first, then use message for operator-facing detail.
  • Account-not-enabled failures return 422 with messages such as Partner is not entitled to purchase Data Packages.
  • Upstream and server-side failures use sanitized response messages; internal traces and raw provider diagnostics are not returned.
  • Retry only where the endpoint contract indicates safe retry behavior (typically with Idempotency-Key).