PQSafeErrorParams

PQSafe AgentPay API Reference v0.1.0

---

PQSafe AgentPay API Reference / PQSafeErrorParams

Interface: PQSafeErrorParams

Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:177

Properties

cause?

optional cause?: Error

Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:199

Optional: the underlying cause (for error chaining).

---

code

code: PQSafeErrorCode

Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:179

Fine-grained error code.

---

context?

optional context?: Record<string, unknown>

Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:189

Structured context for programmatic inspection (amounts, addresses, etc.). All values must be JSON-serializable.

---

human_reason

human_reason: string

Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:184

Human-readable explanation safe for logging and operator dashboards. Do NOT include PII or secret key material here.

---

retry_after_ms?

optional retry_after_ms?: number

Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:195

If retriable, how long the caller should wait before retrying (milliseconds). Provided for RATE_LIMIT errors (parsed from Retry-After header). For other retriable errors, use exponential backoff with this as the floor.