SharedPaymentTokenUsageLimits

PQSafe AgentPay API Reference v0.1.0

PQSafe AgentPay API Reference / Stripe / SharedPaymentTokenUsageLimits

Interface: SharedPaymentTokenUsageLimits

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

Usage limits applied to a Shared Payment Token.

All monetary fields are in the smallest currency unit (e.g. cents for USD). This matches Stripe’s convention for atomic currency amounts.

Properties

allowedCountries?

optional allowedCountries?: string[]

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

Allowed countries for merchant presence (ISO 3166-1 alpha-2). Omit for all countries.

Example

["US", "GB", "HK"]

allowedMerchantCategories?

optional allowedMerchantCategories?: string[]

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

Allowed merchant category codes (ISO 18245 MCCs). Empty array or omitted = all merchants allowed.

Example

["5411", "5912"] — grocery stores and drug stores only

allowedMerchants?

optional allowedMerchants?: string[]

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

Explicit allowlist of Stripe merchant IDs (acct_*) that may charge this token. If set, charges from other merchants are rejected.

blockedMerchants?

optional blockedMerchants?: string[]

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

Explicit blocklist of Stripe merchant IDs that may NOT charge this token. Useful for excluding known high-risk merchants without blocking the category.

currency?

optional currency?: string

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

ISO 4217 currency code for usage limit amounts. Required when any monetary limit is set.

expiresAt?

optional expiresAt?: string

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

ISO 8601 datetime after which the token is expired and cannot be used.

Example

"2026-06-01T00:00:00Z"

maxAmountPerTransaction?

optional maxAmountPerTransaction?: number

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

Maximum amount per individual transaction, in the smallest currency unit.

Example

2000 — $20.00 per transaction

maxTotalAmount?

optional maxTotalAmount?: number

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

Maximum total amount the token may authorize across all transactions, in the smallest currency unit.

Example

10000 — $100.00 USD lifetime ceiling

maxUseCount?

optional maxUseCount?: number

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

Maximum number of times the token may be used. Omit for unlimited usage within other constraints.