effectivePolicy

PQSafe AgentPay API Reference v0.1.0

---

PQSafe AgentPay API Reference / effectivePolicy

Function: effectivePolicy()

effectivePolicy(envelopeFields): { mode: "single_use"; } | { mode: "per_tx_cap"; perTxLimit: number; } | { mode: "cumulative_cap"; resetWindowSeconds?: number; }

Defined in: pqsafe/agent-pay/src/sprint2/policy.ts:147

Return the effective spend policy for an envelope, defaulting to single_use. Safe to call on Sprint 1 envelopes that have no spendPolicy field.

Parameters

envelopeFields

spendPolicy?

{ mode: "single_use"; } | { mode: "per_tx_cap"; perTxLimit: number; } | { mode: "cumulative_cap"; resetWindowSeconds?: number; }

Returns

Type Literal

{ mode: "single_use"; }

---

Type Literal

{ mode: "per_tx_cap"; perTxLimit: number; }

mode

mode: "per_tx_cap"

perTxLimit

perTxLimit: number

Maximum amount per individual payment (same currency as envelope.currency). Must be <= envelope.maxAmount.

---

Type Literal

{ mode: "cumulative_cap"; resetWindowSeconds?: number; }

mode

mode: "cumulative_cap"

resetWindowSeconds?

optional resetWindowSeconds?: number

Optional: reset window in seconds. If set, the cumulative counter resets every resetWindowSeconds. Enables weekly/monthly budget envelopes. If omitted, the cap is lifetime (no reset).