CreateSharedPaymentTokenParams

PQSafe AgentPay API Reference v0.1.0

---

PQSafe AgentPay API Reference / Stripe / CreateSharedPaymentTokenParams

Interface: CreateSharedPaymentTokenParams

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:136

Parameters for creating a Shared Payment Token via the Stripe API. Send to POST /v1/shared_payment_tokens.

Properties

agentId

agentId: string

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:142

Agent identifier (max 64 chars)

---

currency

currency: string

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:144

ISO 4217 currency code for usage limit amounts

---

customer

customer: string

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:140

Stripe customer ID that owns the payment method (cus_*)

---

idempotencyKey?

optional idempotencyKey?: string

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:151

Optional idempotency key to prevent duplicate token creation. Use a UUID v4 or your own order ID.

---

metadata?

optional metadata?: Record<string, string>

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:153

Optional key-value metadata (max 50 keys, 500 chars each)

---

paymentMethod

paymentMethod: string

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:138

Stripe payment method ID to delegate (pm_*)

---

pqEnvelopeRequested?

optional pqEnvelopeRequested?: boolean

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:159

PQSafe extension: if true, Stripe API response is expected to include a pq_envelope field containing the serialized SpendEnvelope. Only set if the merchant is running a PQSafe-integrated Stripe app.

---

usageLimits?

optional usageLimits?: SharedPaymentTokenUsageLimits

Defined in: pqsafe/agent-pay/src/adapters/acp.ts:146

Usage constraints on this token