revoke

PQSafe AgentPay API Reference v0.1.0

---

PQSafe AgentPay API Reference / revoke

Function: revoke()

revoke(_envelopeId, _reason, _config): Promise<RevocationRecord>

Defined in: pqsafe/agent-pay/src/sprint2/revocation.ts:126

Revoke a specific envelope (Layer 3 — granular per-envelope revocation).

Sprint 3 implementation will:

1. POST /v1/issuers/:id/revocations with envelopeId + reason.
2. Hosted service writes revocation record to Postgres + triggers on-chain bit flip.
3. Returns the revocation record with confirmation.

Parameters

_envelopeId

string

_reason

string

_config

RevocationServiceConfig

Returns

Promise<RevocationRecord>

Throws

‘Sprint 2 — implementation queued’ until Sprint 3 ships.