CartMandate
PQSafe AgentPay API Reference v0.1.0
PQSafe AgentPay API Reference / AP2 / CartMandate
Interface: CartMandate
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:143
Cart Mandate — mid-flow mandate with a concrete list of items. Issued after the agent has added items to a cart but before checkout.
Properties
acceptedMethods?
optionalacceptedMethods?:PaymentMethodData[]
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:169
Optional list of accepted payment methods
agentId
agentId:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:165
Agent identifier
currency
currency:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:161
Currency for all monetary fields
expiresAt
expiresAt:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:163
ISO 8601 expiry datetime for this mandate
issuerAddress
issuerAddress:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:167
Issuer PQSafe address
items
items:
PaymentItem[]
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:151
Line items in the cart
mandateId
mandateId:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:147
Unique mandate ID (UUID v4 recommended)
merchantId
merchantId:
string
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:149
Merchant/service identifier
metadata?
optionalmetadata?:Record<string,unknown>
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:173
Optional arbitrary metadata
shipping?
optionalshipping?:number
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:157
Optional shipping amount
shippingAddress?
optionalshippingAddress?:ContactAddress
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:171
Optional buyer shipping address
subtotal
subtotal:
number
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:153
Subtotal (sum of item amounts * quantities)
tax?
optionaltax?:number
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:155
Optional tax amount
total
total:
number
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:159
Grand total (subtotal + tax + shipping)
type
type:
"cart"
Defined in: pqsafe/agent-pay/src/adapters/ap2.ts:145
Mandate type discriminator