Class: Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb

Defined Under Namespace

Modules: Attribute Classes: Parameters

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(attribute:, operation:, value:, parameters: nil) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition for more details.

Parameters:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb', line 24

class Condition < Lithic::Internal::Type::BaseModel
  # @!attribute attribute
  #   The attribute to target.
  #
  #   The following attributes may be targeted:
  #
  #   - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
  #     business by the types of goods or services it provides.
  #   - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
  #     ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
  #     Netherlands Antilles.
  #   - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
  #     the transaction.
  #   - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
  #     (merchant).
  #   - `DESCRIPTOR`: Short description of card acceptor.
  #   - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
  #     fee field in the settlement/cardholder billing currency. This is the amount
  #     the issuer should authorize against unless the issuer is paying the acquirer
  #     fee on behalf of the cardholder. Use an integer value.
  #   - `RISK_SCORE`: Network-provided score assessing risk level associated with a
  #     given authorization. Scores are on a range of 0-999, with 0 representing the
  #     lowest risk and 999 representing the highest risk. For Visa transactions,
  #     where the raw score has a range of 0-99, Lithic will normalize the score by
  #     multiplying the raw score by 10x. Use an integer value.
  #   - `TRANSACTION_STATUS`: The status of the transaction. Valid values are
  #     `PENDING`, `VOIDED`, `SETTLING`, `SETTLED`, `BOUNCED`, `RETURNED`, `DECLINED`,
  #     `EXPIRED`.
  #   - `LAST_EVENT_TYPE`: The type of the most recent event on the transaction. Valid
  #     values are `AUTHORIZATION`, `AUTHORIZATION_ADVICE`, `AUTHORIZATION_EXPIRY`,
  #     `AUTHORIZATION_REVERSAL`, `BALANCE_INQUIRY`, `CLEARING`, `CORRECTION_CREDIT`,
  #     `CORRECTION_DEBIT`, `CREDIT_AUTHORIZATION`, `CREDIT_AUTHORIZATION_ADVICE`,
  #     `FINANCIAL_AUTHORIZATION`, `FINANCIAL_CREDIT_AUTHORIZATION`, `RETURN`,
  #     `RETURN_REVERSAL`.
  #   - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
  #     applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
  #     `TOKEN_AUTHENTICATED`.
  #   - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
  #     (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
  #     `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
  #     `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
  #     `UNKNOWN`, or `CREDENTIAL_ON_FILE`.
  #   - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
  #     source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
  #     `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
  #   - `CARD_AGE`: The age of the card in seconds at the time of the transaction. Use
  #     an integer value.
  #   - `ACCOUNT_AGE`: The age of the account in seconds at the time of the
  #     transaction. Use an integer value. For programs where Lithic does not manage
  #     or retain account holder data, this attribute does not evaluate.
  #   - `SPEND_VELOCITY_COUNT`: The number of transactions matching the specified
  #     filters within the given period. Requires `parameters` with `scope`, `period`,
  #     and optional `filters`. Use an integer value.
  #   - `SPEND_VELOCITY_AMOUNT`: The total spend amount (in cents) of transactions
  #     matching the specified filters within the given period. Requires `parameters`
  #     with `scope`, `period`, and optional `filters`. Use an integer value.
  #   - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
  #     entity's transaction history. Null if fewer than 30 approved transactions in
  #     the specified window. Requires `parameters.scope` and `parameters.interval`.
  #     Use a decimal value.
  #   - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
  #     entity over the specified window, in cents. Requires `parameters.scope` and
  #     `parameters.interval`. Use a decimal value.
  #   - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
  #     amounts for the entity over the specified window, in cents. Null if fewer than
  #     30 approved transactions in the specified window. Requires `parameters.scope`
  #     and `parameters.interval`. Use a decimal value.
  #   - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
  #     in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
  #     Requires `parameters.scope`.
  #   - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
  #     transaction history. Valid values are `TRUE`, `FALSE`. Requires
  #     `parameters.scope`.
  #   - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
  #     Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
  #   - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
  #     the entity over the last 30 days (rolling). Requires `parameters.scope`. Use
  #     an integer value.
  #   - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
  #     transaction for the entity, rounded to the nearest whole day. Requires
  #     `parameters.scope`. Use an integer value.
  #   - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
  #     the entity's transaction history. Requires `parameters.scope`. Use an integer
  #     value.
  #   - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
  #     card's approved transaction history (capped at the 1000 most recently seen
  #     merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
  #     `parameters` required.
  #   - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
  #     a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
  #     Use a decimal value.
  #   - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
  #     between the postal code centers of the last card-present transaction and the
  #     current transaction, divided by the elapsed time. Null if there is no prior
  #     card-present transaction, if either postal code cannot be geocoded, or if
  #     elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
  #     decimal value.
  #   - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
  #     code centers of the last card-present transaction and the current transaction.
  #     Null if there is no prior card-present transaction or if either postal code
  #     cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
  #     Use a decimal value.
  #
  #   @return [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Attribute]
  required :attribute,
           enum: -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Attribute }

  # @!attribute operation
  #   The operation to apply to the attribute
  #
  #   @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation]
  required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation }

  # @!attribute value
  #   A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
  #
  #   @return [String, Integer, Float, Array<String>, Time]
  required :value, union: -> { Lithic::AuthRules::ConditionalValue }

  # @!attribute parameters
  #   Additional parameters for certain attributes. Required when `attribute` is
  #   `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT` (require `scope`, `period`,
  #   and optional `filters`); `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
  #   `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
  #   `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
  #   or `DISTINCT_COUNTRY_COUNT` (require `scope`, and additionally `interval` for
  #   the statistical attributes); or `TRAVEL_SPEED` or
  #   `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used for other
  #   attributes.
  #
  #   @return [Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters, nil]
  optional :parameters,
           -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters }

  # @!method initialize(attribute:, operation:, value:, parameters: nil)
  #   Some parameter documentations has been truncated, see
  #   {Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition}
  #   for more details.
  #
  #   @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Attribute] The attribute to target.
  #
  #   @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute
  #
  #   @param value [String, Integer, Float, Array<String>, Time] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
  #
  #   @param parameters [Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters] Additional parameters for certain attributes. Required when `attribute` is

  # The attribute to target.
  #
  # The following attributes may be targeted:
  #
  # - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
  #   business by the types of goods or services it provides.
  # - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
  #   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
  #   Netherlands Antilles.
  # - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
  #   the transaction.
  # - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
  #   (merchant).
  # - `DESCRIPTOR`: Short description of card acceptor.
  # - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
  #   fee field in the settlement/cardholder billing currency. This is the amount
  #   the issuer should authorize against unless the issuer is paying the acquirer
  #   fee on behalf of the cardholder. Use an integer value.
  # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
  #   given authorization. Scores are on a range of 0-999, with 0 representing the
  #   lowest risk and 999 representing the highest risk. For Visa transactions,
  #   where the raw score has a range of 0-99, Lithic will normalize the score by
  #   multiplying the raw score by 10x. Use an integer value.
  # - `TRANSACTION_STATUS`: The status of the transaction. Valid values are
  #   `PENDING`, `VOIDED`, `SETTLING`, `SETTLED`, `BOUNCED`, `RETURNED`, `DECLINED`,
  #   `EXPIRED`.
  # - `LAST_EVENT_TYPE`: The type of the most recent event on the transaction. Valid
  #   values are `AUTHORIZATION`, `AUTHORIZATION_ADVICE`, `AUTHORIZATION_EXPIRY`,
  #   `AUTHORIZATION_REVERSAL`, `BALANCE_INQUIRY`, `CLEARING`, `CORRECTION_CREDIT`,
  #   `CORRECTION_DEBIT`, `CREDIT_AUTHORIZATION`, `CREDIT_AUTHORIZATION_ADVICE`,
  #   `FINANCIAL_AUTHORIZATION`, `FINANCIAL_CREDIT_AUTHORIZATION`, `RETURN`,
  #   `RETURN_REVERSAL`.
  # - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
  #   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
  #   `TOKEN_AUTHENTICATED`.
  # - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
  #   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
  #   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
  #   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
  #   `UNKNOWN`, or `CREDENTIAL_ON_FILE`.
  # - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
  #   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
  #   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
  # - `CARD_AGE`: The age of the card in seconds at the time of the transaction. Use
  #   an integer value.
  # - `ACCOUNT_AGE`: The age of the account in seconds at the time of the
  #   transaction. Use an integer value. For programs where Lithic does not manage
  #   or retain account holder data, this attribute does not evaluate.
  # - `SPEND_VELOCITY_COUNT`: The number of transactions matching the specified
  #   filters within the given period. Requires `parameters` with `scope`, `period`,
  #   and optional `filters`. Use an integer value.
  # - `SPEND_VELOCITY_AMOUNT`: The total spend amount (in cents) of transactions
  #   matching the specified filters within the given period. Requires `parameters`
  #   with `scope`, `period`, and optional `filters`. Use an integer value.
  # - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
  #   entity's transaction history. Null if fewer than 30 approved transactions in
  #   the specified window. Requires `parameters.scope` and `parameters.interval`.
  #   Use a decimal value.
  # - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
  #   entity over the specified window, in cents. Requires `parameters.scope` and
  #   `parameters.interval`. Use a decimal value.
  # - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
  #   amounts for the entity over the specified window, in cents. Null if fewer than
  #   30 approved transactions in the specified window. Requires `parameters.scope`
  #   and `parameters.interval`. Use a decimal value.
  # - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
  #   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
  #   Requires `parameters.scope`.
  # - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
  #   transaction history. Valid values are `TRUE`, `FALSE`. Requires
  #   `parameters.scope`.
  # - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
  #   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
  # - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
  #   the entity over the last 30 days (rolling). Requires `parameters.scope`. Use
  #   an integer value.
  # - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
  #   transaction for the entity, rounded to the nearest whole day. Requires
  #   `parameters.scope`. Use an integer value.
  # - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
  #   the entity's transaction history. Requires `parameters.scope`. Use an integer
  #   value.
  # - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
  #   card's approved transaction history (capped at the 1000 most recently seen
  #   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
  #   `parameters` required.
  # - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
  #   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
  #   Use a decimal value.
  # - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
  #   between the postal code centers of the last card-present transaction and the
  #   current transaction, divided by the elapsed time. Null if there is no prior
  #   card-present transaction, if either postal code cannot be geocoded, or if
  #   elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
  #   decimal value.
  # - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
  #   code centers of the last card-present transaction and the current transaction.
  #   Null if there is no prior card-present transaction or if either postal code
  #   cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
  #   Use a decimal value.
  #
  # @see Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition#attribute
  module Attribute
    extend Lithic::Internal::Type::Enum

    MCC = :MCC
    COUNTRY = :COUNTRY
    CURRENCY = :CURRENCY
    MERCHANT_ID = :MERCHANT_ID
    DESCRIPTOR = :DESCRIPTOR
    TRANSACTION_AMOUNT = :TRANSACTION_AMOUNT
    RISK_SCORE = :RISK_SCORE
    TRANSACTION_STATUS = :TRANSACTION_STATUS
    LAST_EVENT_TYPE = :LAST_EVENT_TYPE
    LIABILITY_SHIFT = :LIABILITY_SHIFT
    PAN_ENTRY_MODE = :PAN_ENTRY_MODE
    WALLET_TYPE = :WALLET_TYPE
    CARD_AGE = :CARD_AGE
    ACCOUNT_AGE = :ACCOUNT_AGE
    SPEND_VELOCITY_COUNT = :SPEND_VELOCITY_COUNT
    SPEND_VELOCITY_AMOUNT = :SPEND_VELOCITY_AMOUNT
    AMOUNT_Z_SCORE = :AMOUNT_Z_SCORE
    AVG_TRANSACTION_AMOUNT = :AVG_TRANSACTION_AMOUNT
    STDEV_TRANSACTION_AMOUNT = :STDEV_TRANSACTION_AMOUNT
    IS_NEW_COUNTRY = :IS_NEW_COUNTRY
    IS_NEW_MCC = :IS_NEW_MCC
    IS_FIRST_TRANSACTION = :IS_FIRST_TRANSACTION
    CONSECUTIVE_DECLINES = :CONSECUTIVE_DECLINES
    TIME_SINCE_LAST_TRANSACTION = :TIME_SINCE_LAST_TRANSACTION
    DISTINCT_COUNTRY_COUNT = :DISTINCT_COUNTRY_COUNT
    IS_NEW_MERCHANT = :IS_NEW_MERCHANT
    THREE_DS_SUCCESS_RATE = :THREE_DS_SUCCESS_RATE
    TRAVEL_SPEED = :TRAVEL_SPEED
    DISTANCE_FROM_LAST_TRANSACTION = :DISTANCE_FROM_LAST_TRANSACTION

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition#parameters
  class Parameters < Lithic::Internal::Type::BaseModel
    # @!attribute filters
    #
    #   @return [Lithic::Models::AuthRules::SpendVelocityFilters, nil]
    optional :filters, -> { Lithic::AuthRules::SpendVelocityFilters }

    # @!attribute interval
    #   The time window for statistical attributes (`AMOUNT_Z_SCORE`,
    #   `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
    #   all-time history or a specific window (`7D`, `30D`, `90D`).
    #
    #   @return [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Interval, nil]
    optional :interval,
             enum: -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Interval }

    # @!attribute period
    #   The time period over which to calculate the spend velocity.
    #
    #   @return [Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear, nil]
    optional :period, union: -> { Lithic::AuthRules::VelocityLimitPeriod }

    # @!attribute scope
    #   The entity scope to evaluate the attribute against. `GLOBAL` is only valid for
    #   spend velocity attributes.
    #
    #   @return [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Scope, nil]
    optional :scope,
             enum: -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Scope }

    # @!attribute unit
    #   The unit for impossible travel attributes. Required when `attribute` is
    #   `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
    #
    #   For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
    #
    #   For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
    #
    #   @return [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Unit, nil]
    optional :unit,
             enum: -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Unit }

    # @!method initialize(filters: nil, interval: nil, period: nil, scope: nil, unit: nil)
    #   Some parameter documentations has been truncated, see
    #   {Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters}
    #   for more details.
    #
    #   Additional parameters for certain attributes. Required when `attribute` is
    #   `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT` (require `scope`, `period`,
    #   and optional `filters`); `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
    #   `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
    #   `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
    #   or `DISTINCT_COUNTRY_COUNT` (require `scope`, and additionally `interval` for
    #   the statistical attributes); or `TRAVEL_SPEED` or
    #   `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used for other
    #   attributes.
    #
    #   @param filters [Lithic::Models::AuthRules::SpendVelocityFilters]
    #
    #   @param interval [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Interval] The time window for statistical attributes (`AMOUNT_Z_SCORE`, `AVG_TRANSACTION_A
    #
    #   @param period [Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear] The time period over which to calculate the spend velocity.
    #
    #   @param scope [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Scope] The entity scope to evaluate the attribute against. `GLOBAL` is only valid for
    #
    #   @param unit [Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters::Unit] The unit for impossible travel attributes. Required when `attribute` is
    #   `TRAVEL\_

    # The time window for statistical attributes (`AMOUNT_Z_SCORE`,
    # `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
    # all-time history or a specific window (`7D`, `30D`, `90D`).
    #
    # @see Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters#interval
    module Interval
      extend Lithic::Internal::Type::Enum

      LIFETIME = :LIFETIME
      INTERVAL_7_D = :"7D"
      INTERVAL_30_D = :"30D"
      INTERVAL_90_D = :"90D"

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # The entity scope to evaluate the attribute against. `GLOBAL` is only valid for
    # spend velocity attributes.
    #
    # @see Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters#scope
    module Scope
      extend Lithic::Internal::Type::Enum

      CARD = :CARD
      ACCOUNT = :ACCOUNT
      GLOBAL = :GLOBAL

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # The unit for impossible travel attributes. Required when `attribute` is
    # `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
    #
    # For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
    #
    # For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
    #
    # @see Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters#unit
    module Unit
      extend Lithic::Internal::Type::Enum

      MPH = :MPH
      KPH = :KPH
      MILES = :MILES
      KILOMETERS = :KILOMETERS

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#attribute ⇒ Symbol, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Attribute

The attribute to target.

The following attributes may be targeted:

  • ‘MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.

  • ‘COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.

  • ‘CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of the transaction.

  • ‘MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor (merchant).

  • ‘DESCRIPTOR`: Short description of card acceptor.

  • ‘TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer fee field in the settlement/cardholder billing currency. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder. Use an integer value.

  • ‘RISK_SCORE`: Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x. Use an integer value.

  • ‘TRANSACTION_STATUS`: The status of the transaction. Valid values are `PENDING`, `VOIDED`, `SETTLING`, `SETTLED`, `BOUNCED`, `RETURNED`, `DECLINED`, `EXPIRED`.

  • ‘LAST_EVENT_TYPE`: The type of the most recent event on the transaction. Valid values are `AUTHORIZATION`, `AUTHORIZATION_ADVICE`, `AUTHORIZATION_EXPIRY`, `AUTHORIZATION_REVERSAL`, `BALANCE_INQUIRY`, `CLEARING`, `CORRECTION_CREDIT`, `CORRECTION_DEBIT`, `CREDIT_AUTHORIZATION`, `CREDIT_AUTHORIZATION_ADVICE`, `FINANCIAL_AUTHORIZATION`, `FINANCIAL_CREDIT_AUTHORIZATION`, `RETURN`, `RETURN_REVERSAL`.

  • ‘LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or `TOKEN_AUTHENTICATED`.

  • ‘PAN_ENTRY_MODE`: The method by which the cardholder’s primary account number (PAN) was entered. Valid values are ‘AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`, `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`, `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`, `UNKNOWN`, or `CREDENTIAL_ON_FILE`.

  • ‘WALLET_TYPE`: For transactions using a digital wallet token, indicates the source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`, `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.

  • ‘CARD_AGE`: The age of the card in seconds at the time of the transaction. Use an integer value.

  • ‘ACCOUNT_AGE`: The age of the account in seconds at the time of the transaction. Use an integer value. For programs where Lithic does not manage or retain account holder data, this attribute does not evaluate.

  • ‘SPEND_VELOCITY_COUNT`: The number of transactions matching the specified filters within the given period. Requires `parameters` with `scope`, `period`, and optional `filters`. Use an integer value.

  • ‘SPEND_VELOCITY_AMOUNT`: The total spend amount (in cents) of transactions matching the specified filters within the given period. Requires `parameters` with `scope`, `period`, and optional `filters`. Use an integer value.

  • ‘AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the entity’s transaction history. Null if fewer than 30 approved transactions in the specified window. Requires ‘parameters.scope` and `parameters.interval`. Use a decimal value.

  • ‘AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the entity over the specified window, in cents. Requires `parameters.scope` and `parameters.interval`. Use a decimal value.

  • ‘STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction amounts for the entity over the specified window, in cents. Null if fewer than 30 approved transactions in the specified window. Requires `parameters.scope` and `parameters.interval`. Use a decimal value.

  • ‘IS_NEW_COUNTRY`: Whether the transaction’s merchant country has not been seen in the entity’s transaction history. Valid values are ‘TRUE`, `FALSE`. Requires `parameters.scope`.

  • ‘IS_NEW_MCC`: Whether the transaction’s MCC has not been seen in the entity’s transaction history. Valid values are ‘TRUE`, `FALSE`. Requires `parameters.scope`.

  • ‘IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity. Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.

  • ‘CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for the entity over the last 30 days (rolling). Requires `parameters.scope`. Use an integer value.

  • ‘TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved transaction for the entity, rounded to the nearest whole day. Requires `parameters.scope`. Use an integer value.

  • ‘DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in the entity’s transaction history. Requires ‘parameters.scope`. Use an integer value.

  • ‘IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the card’s approved transaction history (capped at the 1000 most recently seen merchants). Valid values are ‘TRUE`, `FALSE`. Card-scoped only; no `parameters` required.

  • ‘THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required. Use a decimal value.

  • ‘TRAVEL_SPEED`: The estimated speed of travel derived from the distance between the postal code centers of the last card-present transaction and the current transaction, divided by the elapsed time. Null if there is no prior card-present transaction, if either postal code cannot be geocoded, or if elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a decimal value.

  • ‘DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal code centers of the last card-present transaction and the current transaction. Null if there is no prior card-present transaction or if either postal code cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`. Use a decimal value.

Returns:



128
129
 
# File 'lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb', line 128

required :attribute,
enum: -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Attribute }

#operation ⇒ Symbol, Lithic::Models::AuthRules::ConditionalOperation

The operation to apply to the attribute

Returns:



135
 
# File 'lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb', line 135

required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation }

#parameters ⇒ Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters?

Additional parameters for certain attributes. Required when ‘attribute` is `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT` (require `scope`, `period`, and optional `filters`); `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`, and additionally `interval` for the statistical attributes); or `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used for other attributes.

Returns:



155
156
 
# File 'lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb', line 155

optional :parameters,
-> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::Condition::Parameters }

#value ⇒ String, ...

A regex string, to be used with ‘MATCHES` or `DOES_NOT_MATCH`

Returns:

  • (String, Integer, Float, Array<String>, Time) 


141
 
# File 'lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb', line 141

required :value, union: -> { Lithic::AuthRules::ConditionalValue }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb', line 306