PaymentMandate

PQSafe AgentPay API Reference v0.1.0

---

PQSafe AgentPay API Reference / AP2 / PaymentMandate

Interface: PaymentMandate

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:180

Payment Mandate — final checkout stage with committed payment method. Issued when the agent is ready to execute a specific payment.

Properties

agentId

agentId: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:200

Agent identifier

---

amount

amount: number

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:188

Committed payment amount

---

billingAddress?

optional billingAddress?: ContactAddress

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:204

Optional buyer billing address

---

currency

currency: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:190

Currency

---

expiresAt

expiresAt: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:198

ISO 8601 expiry datetime for this mandate

---

issuerAddress

issuerAddress: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:202

Issuer PQSafe address

---

items?

optional items?: PaymentItem[]

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:194

Line items (optional at payment stage; may be omitted for subscriptions)

---

mandateId

mandateId: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:184

Unique mandate ID (UUID v4 recommended)

---

merchantId

merchantId: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:186

Merchant/service identifier

---

metadata?

optional metadata?: Record<string, unknown>

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:210

Optional arbitrary metadata

---

paymentMethod

paymentMethod: PaymentMethodData

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:192

Selected payment method

---

purchaseReference?

optional purchaseReference?: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:208

Optional purchase reference (order ID, invoice number, etc.)

---

recipientAddress

recipientAddress: string

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:196

Merchant recipient address (IBAN, EVM address, Stripe customer ID, etc.)

---

shippingAddress?

optional shippingAddress?: ContactAddress

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:206

Optional buyer shipping address

---

type

type: "payment"

Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:182

Mandate type discriminator