IntentMandate
PQSafe AgentPay API Reference v0.1.0
PQSafe AgentPay API Reference / AP2 / IntentMandate
Interface: IntentMandate
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:112
Intent Mandate — earliest stage of agentic commerce. Issued when the agent has expressed purchase intent but has not yet committed to a specific cart or price.
Analogous to a pre-authorization request.
Properties
acceptedMethods?
optionalacceptedMethods?:PaymentMethodData[]
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:132
Optional list of accepted payment methods
agentId
agentId:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:128
Agent identifier (matches SpendEnvelope.agent)
currency
currency:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:124
Currency for maxAmount
description
description:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:120
Human-readable description of the intent
expiresAt
expiresAt:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:126
ISO 8601 expiry datetime for this mandate
issuerAddress
issuerAddress:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:130
Issuer PQSafe address (matches SpendEnvelope.issuer)
mandateId
mandateId:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:116
Unique mandate ID (UUID v4 recommended)
maxAmount
maxAmount:
number
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:122
Maximum amount the agent is authorized to spend for this intent
merchantId
merchantId:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:118
Merchant/service identifier
metadata?
optionalmetadata?:Record<string,unknown>
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:136
Optional arbitrary merchant metadata
shippingAddress?
optionalshippingAddress?:ContactAddress
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:134
Optional buyer shipping address
type
type:
"intent"
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:114
Mandate type discriminator