WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`RateLimiterDefinitionDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

A limiter as the running host declares it: name, grouping, scope, and the defaults a rule overrides.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

name required

string

The limiter's unique name, matched against `RateLimitRule.LimiterName`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

displayName required

string

Human-readable name for the administration UI. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Optional description shown as help text. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

category required

string

Grouping category, for example "API" or "Payment Pages". nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

scope required

RateLimitScope RateLimitScope

The scope the limiter operates at. A profile must bind to the same scope to affect it.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Global`	Platform-wide limit shared across all tenants and merchants.
`PerTenant`	Per-tenant limit. Keyed by the tenant identifier.
`PerMerchant`	Per-merchant limit. Keyed by the merchant identifier.
`PerEntity`	Per-entity limit (for example a specific hosted payment page instance). Keyed by the identifier of that entity.
`PerEndpoint`	Per-endpoint limit. Keyed by the matched endpointPattern rather than the raw request path, so a pattern containing a wildcard produces one bounded counter key instead of one key per distinct URL.
`PerApiKey`	Per-API-key limit. Keyed by the API key identifier (never the key secret).
`PerIpAddress`	Per-IP-address limit. Keyed by the resolved client IP address.

accumulationType required

RateLimitAccumulationType RateLimitAccumulationType

Whether the limiter counts requests or accumulates an amount.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Count`	Counts discrete requests, checked against permitLimit.
`Amount`	Accumulates a decimal amount (for example a transaction value), checked against maxAmount. Only FixedWindow supports amount accumulation.

defaultAlgorithm required

RateLimitAlgorithm RateLimitAlgorithm

The algorithm applied when no rule overrides it.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`FixedWindow`	Fixed (tumbling) window: the counter resets when the window rolls over. The window identifier is derived from the current UTC instant, so every process agrees on the boundary without coordination.
`SlidingWindow`	Sliding window: tracks individual request timestamps over a rolling span using a sorted set. More precise than a fixed window at the cost of more Redis memory.
`TokenBucket`	Token bucket: permits replenish at a steady rate and short bursts are allowed up to the bucket capacity.
`Concurrency`	Concurrency limiter: bounds the number of concurrent in-flight requests. The slot is held for the duration of the downstream request and released afterwards.

defaultPermitLimit required

integer (int32)

The permit limit applied when no rule overrides it.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultMaxAmount required

number (double)

The amount ceiling applied when no rule overrides it, for amount accumulation. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultWindowSeconds required

integer (int32)

The window applied when no rule overrides it, in seconds.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultQueueLimit required

integer (int32)

The burst allowance applied when no rule overrides it.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.