Constructor Detail

Method Detail

• withRawResponse

   abstract V2Service.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract V2Service withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• backtests

   abstract BacktestService backtests()

• create

   V2CreateResponse create(AuthRuleV2CreateParams params)

  Creates a new V2 Auth rule in draft mode

• create

   abstract V2CreateResponse create(AuthRuleV2CreateParams params, RequestOptions requestOptions)

• retrieve

   V2RetrieveResponse retrieve(String authRuleToken)

  Fetches a V2 Auth rule by its token

• retrieve

   V2RetrieveResponse retrieve(String authRuleToken, AuthRuleV2RetrieveParams params, RequestOptions requestOptions)

• retrieve

   V2RetrieveResponse retrieve(String authRuleToken, AuthRuleV2RetrieveParams params)

• retrieve

   abstract V2RetrieveResponse retrieve(AuthRuleV2RetrieveParams params, RequestOptions requestOptions)

• retrieve

   V2RetrieveResponse retrieve(AuthRuleV2RetrieveParams params)

• retrieve

   V2RetrieveResponse retrieve(String authRuleToken, RequestOptions requestOptions)

• update

   V2UpdateResponse update(String authRuleToken, AuthRuleV2UpdateParams params)

  Updates a V2 Auth rule's properties

  If account_tokens, card_tokens, program_level, or excluded_card_tokens is provided, this will replace existing associations with the provided list of entities.

• update

   V2UpdateResponse update(String authRuleToken, AuthRuleV2UpdateParams params, RequestOptions requestOptions)

• update

   V2UpdateResponse update(AuthRuleV2UpdateParams params)

• update

   abstract V2UpdateResponse update(AuthRuleV2UpdateParams params, RequestOptions requestOptions)

• list

   AuthRuleV2ListPage list()

  Lists V2 Auth rules

• list

   abstract AuthRuleV2ListPage list(AuthRuleV2ListParams params, RequestOptions requestOptions)

• list

   AuthRuleV2ListPage list(AuthRuleV2ListParams params)

• list

   AuthRuleV2ListPage list(RequestOptions requestOptions)

• delete

   Unit delete(String authRuleToken)

  Deletes a V2 Auth rule

• delete

   Unit delete(String authRuleToken, AuthRuleV2DeleteParams params, RequestOptions requestOptions)

• delete

   Unit delete(String authRuleToken, AuthRuleV2DeleteParams params)

• delete

   abstract Unit delete(AuthRuleV2DeleteParams params, RequestOptions requestOptions)

• delete

   Unit delete(AuthRuleV2DeleteParams params)

• delete

   Unit delete(String authRuleToken, RequestOptions requestOptions)

• apply

  @Deprecated(message = "deprecated") V2ApplyResponse apply(String authRuleToken, AuthRuleV2ApplyParams params)

  Associates a V2 Auth rule with a card program, the provided account(s) or card(s).

  Prefer using the PATCH method for this operation.

• apply

  @Deprecated(message = "deprecated") V2ApplyResponse apply(String authRuleToken, AuthRuleV2ApplyParams params, RequestOptions requestOptions)

• apply

  @Deprecated(message = "deprecated") V2ApplyResponse apply(AuthRuleV2ApplyParams params)

• apply

  @Deprecated(message = "deprecated") abstract V2ApplyResponse apply(AuthRuleV2ApplyParams params, RequestOptions requestOptions)

• draft

   V2DraftResponse draft(String authRuleToken)

  Creates a new draft version of a rule that will be ran in shadow mode.

  This can also be utilized to reset the draft parameters, causing a draft version to no longer be ran in shadow mode.

• draft

   V2DraftResponse draft(String authRuleToken, AuthRuleV2DraftParams params, RequestOptions requestOptions)

• draft

   V2DraftResponse draft(String authRuleToken, AuthRuleV2DraftParams params)

• draft

   abstract V2DraftResponse draft(AuthRuleV2DraftParams params, RequestOptions requestOptions)

• draft

   V2DraftResponse draft(AuthRuleV2DraftParams params)

• draft

   V2DraftResponse draft(String authRuleToken, RequestOptions requestOptions)

• promote

   V2PromoteResponse promote(String authRuleToken)

  Promotes the draft version of an Auth rule to the currently active version such that it is enforced in the respective stream.

• promote

   V2PromoteResponse promote(String authRuleToken, AuthRuleV2PromoteParams params, RequestOptions requestOptions)

• promote

   V2PromoteResponse promote(String authRuleToken, AuthRuleV2PromoteParams params)

• promote

   abstract V2PromoteResponse promote(AuthRuleV2PromoteParams params, RequestOptions requestOptions)

• promote

   V2PromoteResponse promote(AuthRuleV2PromoteParams params)

• promote

   V2PromoteResponse promote(String authRuleToken, RequestOptions requestOptions)

• report

  @Deprecated(message = "deprecated") V2ReportResponse report(String authRuleToken)

  This endpoint is deprecated and will be removed in the future. Requests a performance report of an Auth rule to be asynchronously generated. Reports can only be run on rules in draft or active mode and will included approved and declined statistics as well as examples. The generated report will be delivered asynchronously through a webhook with event_type = auth_rules.performance_report.created. See the docs on setting up webhook subscriptions.

  Reports are generated based on data collected by Lithic's processing system in the trailing week. The performance of the auth rule will be assessed on the configuration of the auth rule at the time the report is requested. This implies that if a performance report is requested, right after updating an auth rule, depending on the number of events processed for a card program, it may be the case that no data is available for the report. Therefore Lithic recommends to decouple making updates to an Auth Rule, and requesting performance reports.

  To make this concrete, consider the following example:

  • At time t, a new Auth Rule is created, and applies to all auth events on a card program. The Auth Rule has not yet been promoted, causing the draft version of the rule to be applied in shadow mode.

  • At time t + 1 hour a performance report is requested for the Auth Rule. This performance report will only contain data for the Auth Rule being executed in the window between t and t + 1 hour. This is because Lithic's transaction processing system will only start capturing data for the Auth Rule at the time it is created.

  • At time t + 2 hours the draft version of the Auth Rule is promoted to the active version of the Auth Rule by calling the /v2/auth_rules/{auth_rule_token}/promote endpoint. If a performance report is requested at this moment it will still only contain data for this version of the rule, but the window of available data will now span from t to t + 2 hours.

  • At time t + 3 hours a new version of the rule is drafted by calling the /v2/auth_rules/{auth_rule_token}/draft endpoint. If a performance report is requested right at this moment, it will only contain data for events to which both the active version and the draft version is applied. Lithic does this to ensure that performance reports represent a fair comparison between rules. Because there may be no events in this window, and because there may be some lag before data is available in a performance report, the requested performance report could contain no to little data.

  • At time t + 4 hours another performance report is requested: this time the performance report will contain data from the window between t + 3 hours and t + 4 hours, for any events to which both the current version of the Auth rule (in enforcing mode) and the draft version of the Auth rule (in shadow mode) applied.

  Note that generating a report may take up to 15 minutes and that delivery is not guaranteed. Customers are required to have created an event subscription to receive the webhook. Additionally, there is a delay of approximately 15 minutes between when Lithic's transaction processing systems have processed the transaction, and when a transaction will be included in the report.

• report

  @Deprecated(message = "deprecated") V2ReportResponse report(String authRuleToken, AuthRuleV2ReportParams params, RequestOptions requestOptions)

• report

  @Deprecated(message = "deprecated") V2ReportResponse report(String authRuleToken, AuthRuleV2ReportParams params)

• report

  @Deprecated(message = "deprecated") abstract V2ReportResponse report(AuthRuleV2ReportParams params, RequestOptions requestOptions)

• report

  @Deprecated(message = "deprecated") V2ReportResponse report(AuthRuleV2ReportParams params)

• report

  @Deprecated(message = "deprecated") V2ReportResponse report(String authRuleToken, RequestOptions requestOptions)

• retrieveReport

   V2RetrieveReportResponse retrieveReport(String authRuleToken, AuthRuleV2RetrieveReportParams params)

  Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes.

  Time Range Limitations:

  • Reports are supported for the past 3 months only

  • Maximum interval length is 1 month

  • Report data is available only through the previous day in UTC (current day data is not available)

  The report provides daily statistics for both current and draft versions of the Auth rule, including approval, decline, and challenge counts along with sample events.

• retrieveReport

   V2RetrieveReportResponse retrieveReport(String authRuleToken, AuthRuleV2RetrieveReportParams params, RequestOptions requestOptions)

• retrieveReport

   V2RetrieveReportResponse retrieveReport(AuthRuleV2RetrieveReportParams params)

• retrieveReport

   abstract V2RetrieveReportResponse retrieveReport(AuthRuleV2RetrieveReportParams params, RequestOptions requestOptions)