Class VelocityLimitParams
-
- All Implemented Interfaces:
public final class VelocityLimitParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classVelocityLimitParams.BuilderA builder for VelocityLimitParams.
public final classVelocityLimitParams.Filterspublic final classVelocityLimitParams.Scope
-
Method Summary
Modifier and Type Method Description final VelocityLimitParams.Filtersfilters()final VelocityLimitParamsPeriodWindowperiod()The size of the trailing window to calculate Spend Velocity over in seconds. final VelocityLimitParams.Scopescope()final Optional<Long>limitAmount()The maximum amount of spend velocity allowed in the period in minor units (the smallest unit of a currency, e.g. final Optional<Long>limitCount()The number of spend velocity impacting transactions may not exceed this limit in the period. final JsonField<VelocityLimitParams.Filters>_filters()Returns the raw JSON value of filters. final JsonField<VelocityLimitParamsPeriodWindow>_period()Returns the raw JSON value of period. final JsonField<VelocityLimitParams.Scope>_scope()Returns the raw JSON value of scope. final JsonField<Long>_limitAmount()Returns the raw JSON value of limitAmount. final JsonField<Long>_limitCount()Returns the raw JSON value of limitCount. final Map<String, JsonValue>_additionalProperties()final VelocityLimitParams.BuildertoBuilder()final VelocityLimitParamsvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static VelocityLimitParams.Builderbuilder()Returns a mutable builder for constructing an instance of VelocityLimitParams. -
-
Method Detail
-
filters
final VelocityLimitParams.Filters filters()
-
period
final VelocityLimitParamsPeriodWindow period()
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).
-
scope
final VelocityLimitParams.Scope scope()
-
limitAmount
final Optional<Long> limitAmount()
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.
-
limitCount
final Optional<Long> limitCount()
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).
-
_filters
final JsonField<VelocityLimitParams.Filters> _filters()
Returns the raw JSON value of filters.
Unlike filters, this method doesn't throw if the JSON field has an unexpected type.
-
_period
final JsonField<VelocityLimitParamsPeriodWindow> _period()
Returns the raw JSON value of period.
Unlike period, this method doesn't throw if the JSON field has an unexpected type.
-
_scope
final JsonField<VelocityLimitParams.Scope> _scope()
Returns the raw JSON value of scope.
Unlike scope, this method doesn't throw if the JSON field has an unexpected type.
-
_limitAmount
final JsonField<Long> _limitAmount()
Returns the raw JSON value of limitAmount.
Unlike limitAmount, this method doesn't throw if the JSON field has an unexpected type.
-
_limitCount
final JsonField<Long> _limitCount()
Returns the raw JSON value of limitCount.
Unlike limitCount, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final VelocityLimitParams.Builder toBuilder()
-
validate
final VelocityLimitParams validate()
-
builder
final static VelocityLimitParams.Builder builder()
Returns a mutable builder for constructing an instance of VelocityLimitParams.
The following fields are required:
.filters() .period() .scope()
-
-
-
-