Builder

class Builder

A builder for VelocityLimitParams.

Functions

Link copied to clipboard
Link copied to clipboard

Returns an immutable instance of VelocityLimitParams.

Link copied to clipboard

Sets Builder.limitAmount to an arbitrary JSON value.

The maximum amount of spend velocity allowed in the period in minor units (the smallest unit of a currency, e.g. cents for USD). Transactions exceeding this limit will be declined.

Link copied to clipboard

Sets Builder.limitCount to an arbitrary JSON value.

The number of spend velocity impacting transactions may not exceed this limit in the period. Transactions exceeding this limit will be declined. A spend velocity impacting transaction is a transaction that has been authorized, and optionally settled, or a force post (a transaction that settled without prior authorization).

Link copied to clipboard

Sets Builder.period to an arbitrary JSON value.

The size of the trailing window to calculate Spend Velocity over in seconds. The minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofFixed(fixed).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofFixedWindowDay(fixedWindowDay).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofFixedWindowMonth(fixedWindowMonth).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofFixedWindowWeek(fixedWindowWeek).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofFixedWindowYear(fixedWindowYear).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofTrailingWindowObject(trailingWindowObject).

Alias for calling period with VelocityLimitParamsPeriodWindow.ofTrailing(trailing).