Class AuthRuleV2BacktestCreateParams
-
- All Implemented Interfaces:
-
com.lithic.api.core.Params
public final class AuthRuleV2BacktestCreateParams implements Params
Initiates a request to asynchronously generate a backtest for an authorization rule. During backtesting, both the active version (if one exists) and the draft version of the Authorization Rule are evaluated by replaying historical transaction data against the rule's conditions. This process allows customers to simulate and understand the effects of proposed rule changes before deployment. The generated backtest report provides detailed results showing whether the draft version of the Auth Rule would have approved or declined historical transactions which were processed during the backtest period. These reports help evaluate how changes to rule configurations might affect overall transaction approval rates.
The generated backtest report will be delivered asynchronously through a webhook with
event_type=auth_rules.backtest_report.created. See the docs on setting up webhook subscriptions. It is also possible to request backtest reports on-demand through the/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}endpoint.Lithic currently supports backtesting for
CONDITIONAL_BLOCKrules. Backtesting forVELOCITY_LIMITrules is generally not supported. In specific cases (i.e. where Lithic has pre-calculated the requested velocity metrics for historical transactions), a backtest may be feasible. However, such cases are uncommon and customers should not anticipate support for velocity backtests under most configurations. If a historical transaction does not feature the required inputs to evaluate the rule, then it will not be included in the final backtest report.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAuthRuleV2BacktestCreateParams.BacktestRequestpublic final classAuthRuleV2BacktestCreateParams.BuilderA builder for AuthRuleV2BacktestCreateParams.
-
Method Summary
Modifier and Type Method Description final StringauthRuleToken()final Optional<OffsetDateTime>end()The end time of the backtest. final Optional<OffsetDateTime>start()The start time of the backtest. final JsonField<OffsetDateTime>_end()The end time of the backtest. final JsonField<OffsetDateTime>_start()The start time of the backtest. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. final StringgetPathParam(Integer index)final AuthRuleV2BacktestCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AuthRuleV2BacktestCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of AuthRuleV2BacktestCreateParams. -
-
Method Detail
-
authRuleToken
final String authRuleToken()
-
end
final Optional<OffsetDateTime> end()
The end time of the backtest.
-
start
final Optional<OffsetDateTime> start()
The start time of the backtest.
-
_end
final JsonField<OffsetDateTime> _end()
The end time of the backtest.
-
_start
final JsonField<OffsetDateTime> _start()
The start time of the backtest.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
getPathParam
final String getPathParam(Integer index)
-
toBuilder
final AuthRuleV2BacktestCreateParams.Builder toBuilder()
-
builder
final static AuthRuleV2BacktestCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of AuthRuleV2BacktestCreateParams.
The following fields are required:
.authRuleToken()
-
-
-
-