Skip to content

Errors

The Pyng HTTP API uses standard HTTP status codes to indicate whether a request was successful or failed.

For most API endpoints, failed requests return a JSON error response in the format described below.

OAuth 2.0 Token Errors

Errors returned by the OAuth 2.0 token endpoint follow the OAuth 2.0 specification and are not returned in the custom Pyng API error format described on this page.

For token endpoint error behavior, refer to RFC 6749.

Error Response Format

{
  "errors": [
    {
      "message": ""
    }
  ],
  "traceId": "6b54f8d3-04eb-479b-9929-3645ce27dedc",
  "timestamp": 1731821436160
}

Fields

Parameter Key Parameter Data Type Required Notes
errors array Y List of one or more error objects
traceId string Y Unique identifier for request tracing
timestamp integer Y Unix timestamp of the error response

Error Object

Parameter Key Parameter Data Type Required Notes
message string Y Human-readable error message

Notes

  • traceId should be included when contacting support about a failed request.
  • Error messages are intended to help with request troubleshooting and integration diagnostics.
  • The custom error response format on this page does not apply to OAuth 2.0 token endpoint errors.